Learn about data collection steps

Confirm that you can use PI SMT to configure the PI Data Archive. You need not run PI SMT on the same computer on which you run this interface.

If you are running the interface on an interface node, edit the PI Data Archive’s Trust Table to allow the interface to read attributes and point data. If a buffering application is not running on the interface node, the PI trust must allow the interface to write data.

Run the installation kit for the PI Interface Configuration Utility (ICU) on the interface node if the ICU will be used to configure the interface. This kit runs the AF SDK installation kit, which installs both the PI API and the AF SDK.

Run the installation kit for this interface. The kit also runs the AF SDK installation kit which installs both the PI API and the AF SDK if necessary.

If you are running the interface on an interface node, check the computer’s time zone properties. An improper time zone configuration can cause the PI Data Archive to reject the data that this interface writes.

Run the ICU and configure a new instance of this interface. Essential startup parameters for this interface are:

Point Source (/PS=x)

Interface ID (/ID=#)

PI Data Archive (/Host=host:port)

Scan Class (/F=##:##:##,offset)

Use an ODBC based connection tool, such as ODBCTest.exe, to confirm connection between the interface node and RDBMS works.

If you will use digital points, define the appropriate digital state sets.

If needed, add the desired system states to the system digital state set.

Build input tags and, if desired, output tags for this interface. Important point attributes and their purposes are:

PtSecurity must permit read access for the PI identity, group, or user configured in the PI trust that is used by the interface. DataSecurity must permit read access (buffering enabled) or read/write access (unbuffered) for the PI identity, group, or user configured in the PI trust that is used by the interface.

Note: When buffering is configured, the DataSecurity attribute must permit write access for the buffering application’s PI trust or mapping. DataSecurity write permission for the interface’s PI trust is required only when buffering is not configured.

It is recommended to test the connection between the interface node and the RDBMS using any third-party ODBC based application. For example the ODBC Tester app. from Microsoft or any other tool that works with ODBC data sources. Verify that the SQL queries are syntactically correct and they deliver data from/to the above mentioned third-party ODBC based applications.

Take one, (ideally) simple SQL statement, which has been tested in the third party tool and configure an interface tag, which will use it.

Start the interface interactively and confirm its successful connection to the PI Data Archive without buffering. (The DataSecurity attribute for interface points must permit write access for the interface’s PI trust.)

Confirm that the interface collects data successfully.

If output points are required, confirm that output points update the correct values in the data source. Create an output point allowlist file for the interface instance.

Stop the interface and configure a buffering application (either Bufserv or PIBufss).

Start the buffering application and the interface. Confirm that the interface works together with the buffering application by either physically removing the connection between the interface node and the PI Data Archive node, or follow the procedures described in Knowledge Base article KB00300 on the Tech Support Site.

Note: The DataSecurity attribute for interface points must permit write access for the buffering application’s PI trust or mapping. The interface’s PI trust does not require DataSecurity write permission.

Configure the interface to run as a Windows service, dependent on the PI buffering service.

Restart the interface node and confirm that the interface and the buffering application restart.