Developing Connectors with OSIsoft PI AF SDK: Compatibility and Best Practices

Developing Connectors with OSIsoft PI AF SDK: Compatibility and Best Practices

The OSIsoft PI AF (Asset Framework) SDK is a powerful tool for developing applications and connectors that interface with PI Systems. However, when working with various versions of PI Data Archive, it's important to understand the compatibility and best practices for ensuring smooth integration across all systems.

Compatibility Across PI Server Versions

The AF SDK officially supports PI Server versions 3.4.380 and higher. This support range ensures that most of the functionalities of the AF SDK can be utilized without issues. However, what if your infrastructure includes PI Servers older than these versions?

Anecdotal Success with Older Versions

Many developers have successfully used AF SDK with PI Servers predating version 3.4.380. The key to this approach is strategic precaution using the PIServer.Supports method. This method enables developers to check whether specific functions are supported by the PI Server in use.

When limiting your tasks to fundamental data retrieval activities, AF SDK often shows significant flexibility and reliability, even with older server versions. It's essential, though, to conduct thorough testing to verify compatibility, especially when developing connectors intended for use across multiple server systems.

Developing Connectors: Best Practices

1. Utilize the PIServer.Supports Method: Always verify if the PI Server supports the functions you are planning to employ. It helps avoid runtime errors and ensures smoother operations across different server versions.

2. Thorough Testing: Especially for connectors that will be interfacing with various PI Servers, it is critical to thoroughly test using sample data from the actual servers. This can help identify issues early in the development process.

3. Consult Official Release Notes: The release notes provide valuable insights into compatibility and feature support. These notes can be found on the OSIsoft customer portal and can guide development decisions regarding server interactions.

4. Iterative Development and Feedback Loop: Regularly update your connector codebase with the latest insights from AF SDK updates. A feedback loop where you continually integrate new findings into your development process can significantly mitigate compatibility headaches.

Conclusion

While the path might seem daunting, developing connectors with PI AF SDK offers robust capabilities and, with cautious application of best practices, substantial compatibility across PI Servers. Even if your system includes servers older than version 3.4.380, methods like PIServer.Supports facilitate integration, ensuring that your tools remain functional and effective.

For more detailed developer resources or to access the latest release notes, visit the OSIsoft customer portal here. Armed with these tools and knowledge, developers can confidently build robust solutions that leverage the full potential of PI Systems.