Adding an Alarms Data Source

If you are using the Alarm ODBC service, you can display the alarms logged to a relational database with the Alarm Analysis object (available with Proficy Portal Enterprise edition). In order to transfer the alarm data to this object, you need to set up an Alarms connector.

In the Administration application, you can add and configure an Alarms connector to the Proficy Portal server by opening the Alarms folder and selecting the Alarms node. The Administration application displays the following fields:

FIX Data Source Properties 

Property

Description

Logical Name

Specifies a name for the data source. This name need not be the actual name of the relational database table you are accessing.

User Name

Specifies the login name to use when connecting to the database. Click the Connections button to select an SQL data source that has already been configured with the user name, password, and database URL.

Password

Specifies the password to use when logging in to the database. Click the Connections button to select an SQL data source that has already been configured with the user name, password, and database URL.

Database URL

Specifies the URL of the database. Click the Connections button to select an SQL data source that has already been configured with the user name, password, and database URL.

Connections button

Click to display a list of available SQL data sources. When you select one of these data sources, the Alarms connector User Name, Password, and Database URL fields are filled in automatically, based on the SQL data source selected.

Database Table

Specifies the name of the table you want to read alarms from. Click the ellipsis button beside this field to access a list of available tables.

Maximum Number of Rows in the result set check box

Select to set the maximum numbers of rows that are returned for the alarms table you have selected. To return all the rows regardless of how many, clear the check box.

Fetch row count at run-time check box

Select to display the row count returned by each query to the data source (if supported by the driver you are using).

Fetch Columns button

Click to display the column headers from the relational database and maps them to specific iFIX fields.

SQL Column Name column

Lists the SQL column names defined in the relational database.

iFIX Field Name column

Lists the iFIX field name that the connector is mapping SQL data to. To change the iFIX field, click anywhere on the name in this column. A drop-down list appears, allowing you to select the required field.

To add an Alarms data source

  1. In the Proficy Portal client application, click the Administration button on the main toolbar. The Administration application appears.

  2. Click the Connectors & Data Sources button. A directory tree appears.

  3. Expand the Alarms folder and click the Alarms node in this folder. The Add New Alarms Data Source window appears.

  4. In the Logical Name field, enter the name of the data source.

  5. In the Connection Information section, either enter the user name, password, and database URL, or click the Connections button. The Connections button allows you to access SQL data sources. When you select the data source and click OK, the User Name, Password, and Database URL are filled in automatically.

  6. In the Database Table field, enter the name of the table you want to read alarms from, or click the ellipsis button and select the table from a list.

  7. In the Maximum Number of Rows in the Resultset box, enter the maximum number of alarms rows you want to retrieve from the database. If you do not want a limit, clear the check box.

  8. If you want the number of rows to be displayed at run-time, select the Fetch row count at runtime check box.

  9. To display SQL column headers/iFIX field mappings, click the Fetch Columns button.

  10. If you want to change a mapping, click the iFIX field name. A drop-down list appears, allowing you to select a new field name to map to the SQL column.

  11. NOTE: All field names will appear in the iFIX Field Name drop-down list, regardless of which fields have already been mapped to SQL columns.

  12. Click the Apply button to save your changes. The Test, Copy, and Remove buttons appear.

  13. Click the Test button to see if your connection is functioning properly. You will receive a message that the data source test passed or that it failed. If the test passed, you are ready to retrieve data. If the test failed, refer to Troubleshooting Connections to Data Sources.

See Also

Managing a Data Source

Alarms Data Sources