Understand API Version

Note: The API Version is configured during system setup. The configuration options are not available in the Advanced Database Editor (ADE).

There are two versions of API Corrections supported in AVEVA Pipeline Operations for Liquids:

• API1980 - This refers to the standards set by the API in 1980.

• API2004 - This refers to the standards in place by 2004 and subsequent changes to the standards.

The versions are similar. The correction version is applied globally across the RealTime service on which AVEVA Pipeline Operations for Liquids runs. It is not possible to have applications or records apply different versions.

To configure the version to be applied, create a record in the RealTime API table and set the apiversion field in the record to the enumerated type for the desired version: either API1980 or API2004. Only one record is created in this table. If no record is created, the version will be API 2004 by default.

The record must be created using a standard RealTime utility such as DBLL or iSQL. This is not configured in ADE.

The Tanking and Batch Tracking modules no longer use the API version configuration mentioned above. They use the API versions configured on the individual products running through them. On the prodgroup record, a Correction Library dropdown has been added, allowing you to select API 1980, API 2004, or the National Institute of Standards and Technology's Reference Fluid Thermodynamic and Transport Properties (NIST REFPROP) libraries for volume and mass.

Note: The NIST REFPROP correction library is specific to Highly Volatile Liquids (HVL) and only used in Batch Tracking.

Selecting API 1980 will use the API 1980 configuration noted above, but only for that prodgroup (and all its child prodtype records). Selecting API 2004 will use the API 2004 configuration noted above, but again, only for the prodgroup for which it is configured.