AVEVA Pipeline Operations for Liquids 2025 (August 2025 Revision) release notes

Original Release Date

April 25, 2025

Revision Release Date

August 27, 2025

Revision Notice: This document was revised and re-released in August 2025 to remove an inaccurate statement from the Virtual Flow Computer design enhancement notice in the New Features and enhancements section.

The AVEVA Pipeline Operations for Liquids release notes contain information on applicable expectations and limitations, enhancements, additional release information, and the documentation included in this release.

Expectations and limitations

The following expectations and limitations should be considered for this release:

• As of the date of this release, the only supported upgrade path is from 2024 SP1 Patch 1 to 2025—including all hotfixes.

• Important: With this release, the calculation guidelines for the PubSubReceiveQueueSize application setting for MonitorLMSObjects have been revised to provide a more accurate result. Also, the default setting has been reduced from 100,000 to 50,000. For guidance on how the value of PubSubReceiveQueueSize should be calculated based on the scale of the system, refer to "Understand Pipeline Objects global process settings" in the AVEVA Pipeline Operations for Liquids Administrator documentation.

New features and enhancements

The following new features and enhancements were added:

• Batch Tracking now provides more advanced capabilities to track signals associated with the launch, detection, and reception of physical anomalies in the pipeline (commonly known as pigs). Additionally, the following features are now available:

  • The ability to specify a slip factor at the pipeline segment level and optionally configure anomalies to use that value.

  • New optional validations to alarm if the anomaly enters an unexpected route (leading to a segment that is configured to not accept this type of anomaly or does not lead to the designated receiver).

  • A convenience mechanism to set default values for anomaly attributes including the ability to specify a naming prefix.

  • Recording of anomaly related events in a dedicated Historical table (anomaly) to facilitate auditing and reporting.

    For more information, refer to the AVEVA Pipeline Operations for Liquids Administrator documentation and the AVEVA Pipeline Operations for Liquids Controller documentation.

• Controllers now have the ability to monitor the mass associated with volumes reported by Virtual Flow Computers, Batch Transfers, and Batch Tracking.

  Mass is automatically calculated at the following granularities for the following applications:

  Batch Transfer

  • Batch Transfer Source

  • Batch Transfer

    Virtual Flow Computer (VFC)

  • Accumulator

  • VFC

    Batch Tracking

  • Fragment

  • Batch

  • Pipe Segment

  • Section

  • Pipeline

    For more information, refer to the AVEVA Pipeline Operations for Liquids Controller documentation.

• A new extension point is now available to enable the customization of hydraulic profiles in Batch Tracking. With this feature, a public Application Programming Interface (API) can now be used to process custom data attributes associated with profile points. The API can also be used to override the system-calculated values of baseline attributes. For more information on this feature, refer to the AVEVA Pipeline Operations for Liquids Developer documentation.

• A new extension point is now available to enable the customization of the Historical inventory snapshot in Batch Tracking. With this feature, a public Application Programming Interface (API) can now be used to include custom RealTime database (RTDB) fields and calculated values in the Batch Tracking inventory snapshot before it is sent to the Historical database.

  For more information on this feature, refer to the AVEVA Pipeline Operations for Liquids Developer documentation.

• Countdowns of type Full Automatic can now be automatically started and stopped using configurable states and are no longer limited to only use points that have START and STOP states within the message set. For example, with this enhancement a countdown can be configured to automatically start when a valve goes to an OPEN state and automatically stop when a valve goes to a CLOSED state. For backwards compatibility, existing Full Automatic countdowns will continue to be automatically started and stopped when triggered by START and STOP states, respectively.

  For more information on how to change this default behavior and use configurable states instead, refer to the AVEVA Pipeline Operations for Liquids Administrator documentation.

• The minimum volume delta requirements for weighted average calculations and ticket splitting have been removed. This enhancement enables the inclusion of very small volume deltas in weighted average calculations and allows the Controller to split any non-zero ticket.

• The Pipeline Monitor (PLM) application now includes the RealTime database (RTDB) field rampstate in the PLM Historical record to indicate whether a specific PLM term was in a dynamically expanded state.

  The field is now available in the following Historical tables: CollectS0, CollectS1, CollectS2, CollectS3, CollectL1, CollectL2, CollectL3, CollectX1, CollectX2, and CollectX3.

  Records historized prior to this enhancement will have this field set to null.

  For more information, refer to the AVEVA Pipeline Operations for Liquids Administrator documentation.

• The Virtual Flow Computer (VFC) now communicates directly with the RealTime database (RTDB) and no longer relies on asynchronous in-memory object repositories. These design enhancements will not affect the core metering functionality of VFCs and will offer the following benefits:

  • Reduced load on the RTDB created by unnecessary sync activities.

  • Resolved nuisance issues resulting from data not being available in the in-memory repositories during system startup (for example, exceptions previously being thrown at startup due to missing unit profiles).

  • Reduced complexity for future enhancements.

    Additionally, a PubSubReceiveQueueSize application setting is now available to allow the queue size to be set explicitly for the VFC application. A default value of 50,000 is used. The AVEVA Pipeline Operations for Liquids Administrator documentation has been updated to provide guidance on how the value of PubSubReceiveQueueSize should be calculated based on the scale of the system.

    Note: As part of the enhancements, the Virtual Flow Computer global process settings within the LMS > VirtualFlowComputer section have changed.

    The following process settings are no longer being used. If you have previously made overrides for these settings, you can safely discard them. If you keep the overrides, they will be ignored.

  • HotAssertDelay

  • AccumDataWriterSleepTimeSpan

  • AccumDataMonitorSleepTimeSpan

  • IntegrityMonitorSleepTimeSpan

  • RateMonitorSleepTimeSpan

  • AnalogUnitProfileProdtypeProdgroupSleepTimeSpan

  • MaxDegreeOfParallelism

    The following process settings have been added. The LMS.RealTime.json file will be updated automatically when you deploy this release. No action is required post-deployment unless you want to modify the default values. For more information, refer to the AVEVA Pipeline Operations for Liquids Administrator documentation.

  • CriticalProcess

  • RestartProcessOnUnexpectedExit

  • CheckinTimeout

  • StartUpDelay

  • PubSubReceiveQueueSize

• The legacy collect-by-exception mechanism used for some VFC and Tank fields has now been removed. The following configuration files have been modified to provide equivalent functionality using the High Performance Data Export Framework (HPDEF):

  • RealTime_DataExport_TimeSeriesCollectPlugin.json

  • RealTime_DataExport_TimeSeriesCollectPlugin_Extension.json

• With the release of AVEVA Pipeline Operations for Liquids 2025, you can access the online help files via the AVEVA Help Viewer or the AVEVA Documentation Portal.

  This release marks the transition of our online help from the AVEVA Help Viewer to the AVEVA Documentation Portal, which offers enhanced security, unified product content, faster search functionality, and a modern user experience with customization options.

  Future releases will not include or support the AVEVA Help Viewer, but documentation will still be available with the installation media in PDF (user documentation) and HTML (API reference documentation) formats.

  To view the AVEVA Pipeline Operations for Liquids documentation on the AVEVA Documentation Portal, sign in with your AVEVA product-support credentials (the same ones used for the Knowledge and Support Center).

  As the AVEVA Documentation Portal evolves, previously released versions of the documentation will be available for download as PDFs and HTML zip files.

  For more information, visit the AVEVA Documentation Portal.

• We have updated the language used in our deliverables to be more consistent and modern.

Deprecated features

The following features were deprecated or removed:

• With this release, support is now discontinued for using SimSuite Pipeline (SSP) Integrated Development Environment (IDE) (SSPDraw) to configure flow network models and upload them to the RealTime database (RTDB). AVEVA Process Simulation and AVEVA Pipeline Integrity Monitor (SimConstruct) must be used instead. Models that have already been built using SSPDraw can be migrated to AVEVA Process Simulation using a procedure described in the AVEVA Pipeline Operations for Liquids Administrator documentation.

  As part of this change, the section on "Working with SimSuite Pipeline (SSP) Integrated Development Environment (IDE) (SSPDraw)" has been removed from the AVEVA Pipeline Operations for Liquids Administrator documentation.

• As of the AVEVA Pipeline Operations for Liquids 2024 SP1 release, the DRARate.flowRate[0..3].point field has been deprecated and replaced with the DRARate.flowRate[0..3].path field.

  With this release, the DRARate.flowRate[0..3].point field is now discontinued.

• As of the AVEVA Pipeline Operations for Liquids 2024 release, the LINEAR field within Batch Tracking (BT) files has been deprecated and replaced with the improved LINEPACKMETHOD field. With this release, the LINEAR field is now discontinued.

• The NIST Reference Fluid Thermodynamic and Transport Properties Database (REFPROP) Mass linepack correction method will be deprecated in a future major release. The mass calculation enhancements delivered with this release provide the recommended alternative for mass tracking.

Schema change information

The following tables detail the RealTime database (RTDB) schema changes that were made as part of the new features and enhancements or defect fixes in this release.

Arrays

Enumerations

Structures

Tables

Display change information

The following easy eXtended Operator Stations displays were modified as part of the new features and enhancements or defect fixes in this release:

• CNTL_ANOMALY_EDIT.XEM

• CNTL_ANOMALY_INSERT.XEM

• CNTL_ANOMALY.XEM

• CNTL_BATCH_ETA.XEM

• CNTL_BATCHXFER_DEVICE_ACCUM.XEM

• CNTL_BATCHXFER_DEVICE_STORAGE.XEM

• CNTL_BATCHXFER_EDIT.XEM

• CNTL_BATCHXFER_SOURCE.XEM

• CNTL_BATCHXFER_TICKET_COMP.XEM

• CNTL_BATCHXFER_TICKET_EDIT.XEM

• CNTL_BATCHXFER_TICKET_PENDING.XEM

• CNTL_BATCHXFER.XEM

• CNTL_FRAGMENT_EDIT.XEM

• CNTL_FRAGMENT_INSERT.XEM

• CNTL_PIPELINE.XEM

• CNTL_SEGMENT.XEM

• CNTL_VIRTUALFLOWCOMPUTER.XEM

• SELECT_ADETECT.XEM

• SELECT_ANOMTYPE.XEM

• SELECT_NODE.XEM

• SUM_ANOMLY_POINT.XEM

• SUM_BATCHXFER_COMPLETED_POINT.XEM

• SUM_BATCHXFER_SOURCE.XEM

• SUM_BATCHXFER.XEM

• SUM_CUTTYPE_POINT.XEM

• SUM_INTERFACE_POINT.XEM

• SUM_VIRTUALFLOWCOMPUTER.XEM

Fixed issues

The following issues were fixed.

Known issues

The following known issues were open at the time of this release.

User documentation

This release includes three options to access and view the AVEVA Pipeline Operations for Liquids persona-based user documentation:

• Single user guides in PDF form.

• A web suite of documentation that includes all of the AVEVA Pipeline Operations for Liquids user documentation in a single web help system.

• (New) The AVEVA Documentation Portal.

  For more information about the AVEVA Documentation Portal, refer to the "New features and enhancements" section of the AVEVA Pipeline Operations for Liquids Release Notes documentation.

  Note: The latest version of the documentation is available on the AVEVA Knowledge & Support Center and the AVEVA Documentation Portal.

The following user documentation is included with this release:

• AVEVA Documentation Portal

  To view the AVEVA Pipeline Operations for Liquids user documentation on the portal, sign in with your AVEVA product-support credentials (the same ones used for the Knowledge and Support Center).

• AVEVA Pipeline Operations for Liquids Web Help (HTML)

  There are three ways to access the Web Help:

  • Download the Web Help package from Citrix ShareFile, and install it on a web server for users in your work environment to access.

    The package contains a web.config file that includes the required MIME type definitions.

  • Via the AVEVA Knowledge & Support Center.

  • View it through the AVEVA Help Viewer consolidated product documentation utility installed with AVEVA Pipeline Operations for Liquids. By default, this product documentation utility can be accessed by browsing to https://localhost:5000 in any web browser.

    Note: For the best online help experience, we recommend using a web browser like Microsoft Edge, Google Chrome, or Mozilla Firefox. For more information on installing the AVEVA Help Viewer, please contact AVEVA Customer Support.

• AVEVA Pipeline Operations for Liquids Administrator documentation

• AVEVA Pipeline Operations for Liquids Controller documentation

• AVEVA Pipeline Operations for Liquids Developer documentation

• AVEVA Pipeline Operations for Liquids Supported Configurations documentation

• AVEVA Pipeline Operations for Liquids Release Notes documentation (this document)

Pre-installation instructions

This section contains the pre-installation instructions for this release.

Readiness for the Anomaly Type table duplicate record clean-up

Using iSQL or Advanced Database Editor (ADE), inspect the Anomaly Type table (anmtype) to ensure that all anmtype records are assigned to a dataset. This step is necessary to enable a post-deployment script that will perform a clean-up task for duplicate records created on non-owning sites from the lms.anmtype.init file when the loadblankdb operation is performed.

Post-installation instructions

This section contains the post-installation instructions for this release.

Populating the eGMTtime field in the Historical ticketTotal table

As part of the AVEVA Pipeline Operations for Liquids 2025 release, a new column called eGMTtime of type GMTtime(int) has been added to the Historical ticketTotal table to enable sorting based on when a ticket was completed. Previously, the existing column eTime of type CHAR(25), that was used to determine the sort order, failed to produce the expected sorting due to the column type.

Follow the procedure to populate the newly created column. The script will retrieve the text value of the existing column eTime, convert it into an epoch timestamp, and then copy the converted value into the column eGMTtime.

Notes: Applying this procedure will affect all existing records in the ticketTotal table. Newly created records will always have this column populated.
Applying this procedure is required for the Batch Transfer—Completed Tickets display to correctly sort the tickets by the end time of the ticket.

To populate the eGMTtime column

After deploying the release package and updating the LMS Historical database, proceed as follows on each Historical server:

1. Sign in to the server as a member of the DNA Developers group.

2. Open Microsoft SQL Server Management Studio.

3. Connect to the Microsoft SQL Server OASySHDB instance.

4. Navigate to the following location:

   C:\Program Files\AVEVA\DNA\Historical\config\applicationsql\Historical\TicketTotal

5. Open Historical_TicketTotal_eGMTtime.sql.

6. Select Execute.

Anomaly Type table duplicate record clean-up script

After owning and non-owning sites have been upgraded and started, follow the procedure below to cleanup duplicate records that might have been created in the Anomaly Type table (anmtype) on the non-owning sites.

For each non-owning site, on the Hot RealTime database (RTDB) server:

• If you are using a Windows Core computer, open a Windows Command prompt, and execute the following commands:

  Powershell

  set-location "$env:DNAInstallRoot\shared\scripts\"

  Set-silo Realtime

  cd Scripts\UpgradeScripts\manual

  RemoveAnmType.csc

• If you are using a desktop experience computer, double-click the Windows PowerShell for DNA shortcut on your desktop and execute the following commands:

  set-Silo RealTime

  cd Scripts\UpgradeScripts\manual

  RemoveAnmType.csc

The execution of the script outputs information about the deleted records to the PowerShell console. For example:

Anomaly type pig with ptnum 1 will be deleted from anomaly table.

Anomaly type startmerge with ptnum 2 will be deleted from anomaly table.

Enhanced Anomaly Detection Message Set

The enhanced anomaly detection capabilities require the use of a new message set adetectEnhanced. Follow this procedure to add the new message set to the message table:

7. Copy the entire message set block adetectEnhanced from the message.init file in the upgraded server.

8. Append the new message set to the end of the message.l file generated using the text_save process.

9. Save the file.

Mass support scripts

AVEVA Pipeline Operations for Liquids 2025 provides supports for mass calculation in metering, ticketing and linefill. Note the following:

New Mass Units in the Unit Profile

To support mass calculations, the RealTime unitprofile table has been extended to include mass units. The default unitprofile for mass will come from the unitprofile.init file. However, if you have created your own unit profiles, before doing a text_load during the upgrade, you must execute a script to append the mass units to the records saved in the unitprofile.l file. The script is provided here:

"DNAInstallRoot\RealTime\scripts\UpgradeScripts\manual\mass_support_script.ps1". This script takes as input the unitprofile.l file generated using the text_save process, checks the name of each unitprofile record and appends a mass unit of kg (for names containing metric) or a mass unit of lbs (for names containing imperial), then produces a modified version of the file containing the mass units. If you would like to run the script, complete the following procedure.

On the Hot RealTime database (RTDB) server on the Global Table Owner site:

• If you are using a Windows Core computer, open a Windows Command prompt, and execute the following commands:

  Powershell

  set-location "$env:DNAInstallRoot\shared\scripts\"

  set-silo RealTime

  cd Scripts\UpgradeScripts\manual

  Import-Module .\mass_support_script.ps1

  set-Location $env:DNADataRoot\RealTime\database\INTEL_NT

  Write-Unit-Profile <unitprofile.l>

• If you are using a desktop experience computer, double-click the Windows PowerShell for DNA shortcut on your desktop and execute the following commands:

  set-silo RealTime

  cd Scripts\UpgradeScripts\manual

  Import-Module .\mass_support_script.ps1

  set-Location $env:DNADataRoot\RealTime\database\INTEL_NT

  Write-Unit-Profile <unitprofile.l>

The execution of the script outputs information about the updated records to the PowerShell console. For example:

Mass unit of kg added to unit profile Metric.

Mass unit of lbs added to unit profile Imperial.

Note: Before you do a text_load using the modified *.l file, inspect the file to ensure accuracy and delete the modified file once it has been merged to the original file.

Metering and Ticketing

Accumulators, Virtual Flow Computers (VFC), Batch Transfer Sources and Batch Transfers that were active before the upgrade, will only start to accumulate mass after the upgrade is completed (except for Orifice meters which already had this capability as of 2024 SP1). Therefore, mass values for these records will only correspond to the portion of the volume that accumulates after the upgrade. Until all preexisting tickets are completed, assume that calculated mass values are not valid.

Batch Tracking

Active Fragments and Batches which has already accumulated volume from a VFC or a Batch Transfer before the upgrade, will only start to accumulate mass after the upgrade is completed. Therefore, mass values for these records will only correspond to the portion of the volume that accumulates after the upgrade. Until all preexisting batches leave the pipeline, assume that calculated mass values are not valid.

Fragments and Batches that were not actively accumulating volume before the upgrade (also known as completed) will have a mass value of zero. If a side stream injection is applied to completed Fragments and Batches after the upgrade, mass values for these records will only correspond to the portion of the volume that comes from the side stream injection. Until all preexisting batches leave the pipeline, assume that calculated mass values are not valid.

Optionally, before doing a text_load during the upgrade, you can execute a script to calculate mass values and append them to the records saved in the .l files. A template of this script is provided here: "DNAInstallRoot\RealTime\scripts\UpgradeScripts\manual\mass_support_script.ps1". This script takes as input the fragment.l and batch.l files generated using the text_save process, calculates mass for fragments and batches, and produces a modified version of the fragment.l and batch.l files. Depending on the units of the volume and density used in your pipeline, you might need to edit the script to provide additional unit handling logic. If you want to run the script, complete the following procedure:

On the Hot RealTime database (RTDB) server on the Global Table Owner site:

• If you are using a Windows Core computer, open a Windows Command prompt, and execute the following commands:

  Powershell

  set-location "$env:DNAInstallRoot\shared\scripts\"

  set-silo RealTime

  cd Scripts\UpgradeScripts\manual

  Import-Module .\mass_support_script.ps1

  set-Location $env:DNADataRoot\RealTime\database\INTEL_NT

  Write-Fragment-Mass <fragment.l> <batch.l>

  Write-Batch-Mass <batch.l>

• If you are using a desktop experience computer, double-click the Windows PowerShell for DNA shortcut on your desktop and execute the following commands:

  set-silo RealTime

  cd Scripts\UpgradeScripts\manual

  Import-Module .\mass_support_script.ps1

  set-Location $env:DNADataRoot\RealTime\database\INTEL_NT

  Write-Fragment-Mass <fragment.l> <batch.l>

  Write-Batch-Mass <batch.l>

The execution of the script outputs information about the updated records to the PowerShell console. For example:

Fragment ATBTPipeline01dbll001 with volume = <XXX>, density = <XX> , density type = API is calculated as mass = <XXX>.

Batch ATBTPipeline01dbll001 with volume =<XXX>, density =<XX>, density type = <XX> is calculated as mass =<XXX> ATBTPipeline01dbll001 with density = 10 , unit = API.

Note: Before you do a text_load using the modified .l files, inspect the files to ensure accuracy.