From PI Process Book to PI Vision: A complete migration guide
Originally published 19 June 2023 · werusys · Categories: General, Industrial Intelligence, OSIsoft, Seeq
Today we look at the transition from OSIsoft’s PI Process Book to PI Vision. You might be considering such a migration given PI Vision’s modern, web-based platform. However, the transition can present challenges — particularly when PI Process Book displays contain custom Visual Basic (VB) scripts. Let us break down how to handle this process effectively.
Because forward planning is critical for your operations, it helps to know that PI ProcessBook is being retired in several stages. The first of these are listed below:
• End of all sales: 31 December 2021
• End of security updates: 31 December 2022
• End of support: 31 December 2024
For further details on OSIsoft’s software and support delivery terms, please refer to the SLA and SRP documents you have signed.
Understanding the Migration
Migrating from PI Process Book to PI Vision involves using PI Vision’s conversion tool to transform PI Process Book displays (.pdi files) into PI Vision displays. However, this tool has limitations with more complex features, particularly those involving custom VB scripts. PI Vision uses JavaScript instead of VB, which means that any VB code must be rewritten in JavaScript.
Steps to Migration
1. Assessment and Planning
Start by assessing your current situation. How many displays do you need to migrate, and how complex are they? Do they contain custom VB code? Draw up a detailed roadmap before you begin the migration process.
2. Using the PI Process Book to PI Vision Migration Tool
PI Vision provides a migration tool for converting PI Process Book displays into the PI Vision format. Here is a step-by-step guide to using it:
- Prepare your files: make sure all PI Process Book display files (.pdi) you want to migrate are properly saved and backed up.
- Launch the tool: start the conversion tool. You will be prompted to specify the location of your .pdi files.
- Select displays: choose the display(s) you want to convert. You can select individual displays or a folder containing several displays.
- Begin conversion: start the conversion process. The tool generates a report listing any errors or issues it encounters.
- Review the report: examine the report carefully. Some elements may not have converted correctly — particularly complex ones or those involving custom VB scripting.
- Verify the converted displays: open the converted displays in PI Vision to check their appearance and functionality.
3. Convert¢ing Custom VB Code
Identify the displays that contain custom VB code. Because VB is not compatible with PI Vision, these sections must be rewritten in JavaScript. PI Vision lets you create custom symbols in JavaScript that can replace the functionality of your VB code.
4. Manual Reconstruction
Some elements from PI Process Book may have no direct equivalent in PI Vision, or cannot be converted by the tool. These elements have to be recreated manually in PI Vision.
5. Testing
After migration, test each display thoroughly to make sure it works as intended. Check data accuracy, trend displays, interactivity, and so on.
6. User Training
As a new tool, PI Vision may take users some time to get used to. Training can help ensure a smooth transition.
The Case of Custom VB Scripts
Handling displays that contain custom VB code can be the most difficult part of the migration. In PI Process Book, you may have used VB to add features such as custom calculations, dynamic display changes, or responses to user interactions. In PI Vision, these features have to be recreated through custom symbols built in JavaScript.
To tackle this:
- Identify the VB code: search through your PI Process Book displays and mark the sections where VB code is used.
- Understand the functionality: examine the VB code and work out what it does. This forms the basis for building a functionally equivalent JavaScript version.
- Program in JavaScript: PI Vision lets you create custom symbols in JavaScript. These symbols should reproduce the functionality previously provided by VB.
- Test: once your JavaScript code is in place, test it thoroughly. Make sure it behaves as intended across different scenarios and with different data.
In summary, migrating from PI Process Book to PI Vision — especially where custom VB code is involved — can seem daunting. With careful planning and a clear understanding of the process, however, you can achieve a smooth transition and upgrade to a far more versatile visualization system.
Happy migrating!


How Seeq Can Support the Migration
When you face the challenge of migrating from PI Process Book to PI Vision — and in particular the move from Visual Basic to JavaScript — Seeq can be a valuable addition.
Seeq is an advanced analytics application for process data, offering capabilities for data collection, cleansing, modelling, and visualization. The platform can integrate data from a wide range of sources, including OSIsoft PI.
Here are some of the reasons Seeq can help during a migration:
- Data integration: Seeq can access your PI data seamlessly, which significantly simplifies the transition.
- Powerful analytics: Seeq provides strong analytical tools that help you identify trends and patterns in your data — especially useful when you are replacing the functions of custom VB code.
- Flexibility: Seeq supports a variety of data models and analytical methods, making it a flexible solution for data visualization.
- JavaScript support: like PI Vision, Seeq also supports JavaScript, which makes it easier to create and implement custom functions.
- Training and support: Seeq offers comprehensive training resources and customer support to help you get up to speed with the platform and resolve any issues.
In short, Seeq can be a valuable ally throughout the PI Process Book to PI Vision migration by providing a powerful, flexible, and user-friendly solution for data visualization and analysis.



