XBR-SV200-XPFv4.0.0-PV900 Upgrade Guide
Overview
This guide covers the changes introduced in XBR-SV200 (released with Xperiflow v4.0.0) that affect existing integrations built on Xperiflow Business Rules (XBR). If you have Assembly or Business Rule code that calls XBR from a prior SV1XX release, review the breaking changes below and update your integration before upgrading.
Who this affects
Any solution or Business Rule that instantiated and used the XperiflowAppClient to interact with Xperiflow (routines, storage, forecasting, jobs, and so on). If your code references XperiflowAppClient, you will need to migrate to the new, purpose-specific clients described below.
Breaking change — Client segmentation
In XBR-SV200, the single XperiflowAppClient was split into several purpose-specific clients, mirroring the API restructuring introduced in Xperiflow v4.0.0. Each new client owns a focused area of functionality.
The most common integration points — Routines and Storage (MetaFileSystem) — now use dedicated clients that are passed into RoutineClient and MetaFileSystemClient respectively, instead of XperiflowAppClient.
New clients
Client | Purpose | Relevance to integrations | Entry-point class |
|---|---|---|---|
| Interact with Routines in Xperiflow. Pass this into
| High |
|
| Same as
| High |
|
| Everything MetaFileSystem-related. Pass this into
| High |
|
| All TimeSeries Forecasting functionality — the largest client, and the majority of what was previously
| Medium | — |
| Running Jobs and viewing Job history. | Medium | — |
| Manage all Generator Packages in an environment (the package repository); per-project generators are managed via
| Medium | — |
| User security within Xperiflow — the functionality exposed by XAT. | Medium | — |
| Interact with the LLM Chat resources of Xperiflow. | Low |
|
| Manage Xperiflow Codespaces. | Low | — |
| Create or interact with active Component Workflows within solutions. | Low | — |
| Manage global settings within Xperiflow. | Low | — |
| Manage versions and upgrades of Xperiflow. | Low | — |
| Retrieve or update low-level configuration (for example
| Low | — |
| Retrieve WebApp information and manage stylesheets Xperiflow uses to style WebApps. | Low | — |