This is an automated email from the ASF dual-hosted git repository.
mridulpathak pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/trunk by this push:
new d8cf4d5ead Add upgrade notes for the framework and applications
d8cf4d5ead is described below
commit d8cf4d5ead60a02e8cef3b1b43532ad691f5550a
Author: Mridul Pathak <[email protected]>
AuthorDate: Mon Nov 2 18:54:14 2026 +0530
Add upgrade notes for the framework and applications
UPGRADING.md lists the environment, configuration, custom code, theme and
data changes needed to upgrade the framework and themes from 24.09, and
applications/UPGRADING.md does the same for the applications.
DATAMODEL_CHANGES.adoc gains the entities and fields added or removed since
24.09 that it was missing, and the decryptFinAccountCodes migration. The README
links to both files, and the pull request template and CI/CD readme ask for an
entry with each public API change.
---
.github/README-CI-CD.md | 2 +-
.github/pull_request_template.md | 3 +
README.md | 4 +
UPGRADING.md | 200 ++++++++++++++++++++++++++
applications/UPGRADING.md | 83 +++++++++++
applications/datamodel/DATAMODEL_CHANGES.adoc | 23 +++
6 files changed, 314 insertions(+), 1 deletion(-)
diff --git a/.github/README-CI-CD.md b/.github/README-CI-CD.md
index 9a7f4316fc..a5058e4b33 100644
--- a/.github/README-CI-CD.md
+++ b/.github/README-CI-CD.md
@@ -49,7 +49,7 @@ New branches inherit workflow files from `trunk` at creation
time.
PRs labeled `cve` are listed under Security fixes and the other PRs labeled
`security` under Security hardening. These labels are set by hand: `cve` only
once the CVE is announced, then the release notes of the release can be
generated again, and `security` by the committer for security hardening without
a CVE.
-PRs that change or remove a public API (a public class, method or signature
that code outside OFBiz may use) are labeled `api-change` by hand by the
committer, and are listed under API changes so that upgraders find them. A PR
labeled `cve` or `security` stays in its security section.
+PRs that change or remove a public API (a public class, method or signature
that code outside OFBiz may use) are labeled `api-change` by hand by the
committer, and are listed under API changes so that upgraders find them. The
same PR adds the upgrade steps to `UPGRADING.md` (framework and themes) or
`applications/UPGRADING.md`. A PR labeled `cve` or `security` stays in its
security section.
GitHub reads `release.yml` from the tag being released, so it must be on the
release branch before the tag is created.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 10aa7e179f..80b97d2f8e 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -6,6 +6,9 @@
[More detailed explanation of what has been done and what the fix achieves,
side effects etc.]
+[If this changes or removes a public API, add an entry to UPGRADING.md or
+applications/UPGRADING.md.]
+
[Thanks:] [xxxx for ... and yyyy for]
## For more information
diff --git a/README.md b/README.md
index b776be2f1b..53e1682477 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,10 @@ For more details about OFBiz please visit the OFBiz
Documentation page:
> **Note** -
> If you are in China you may encounter network issues or proxy settings. This
> is unrelated to OFBiz.
+> **Note** -
+> If you are upgrading from an earlier release, read
[UPGRADING.md](UPGRADING.md) and
+> [applications/UPGRADING.md](applications/UPGRADING.md).
+
## System requirements
diff --git a/UPGRADING.md b/UPGRADING.md
new file mode 100644
index 0000000000..992a13353e
--- /dev/null
+++ b/UPGRADING.md
@@ -0,0 +1,200 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Upgrading Apache OFBiz
+
+This file lists what you need to change in your environment, configuration,
custom code and data when you upgrade
+the OFBiz framework and themes to a new major release. Each layer keeps its
own notes, next to the code they describe:
+
+* the framework and themes: this file
+* the applications: [applications/UPGRADING.md](applications/UPGRADING.md),
with the application data model changes
+ in
[applications/datamodel/DATAMODEL_CHANGES.adoc](applications/datamodel/DATAMODEL_CHANGES.adoc)
+* the plugins:
[UPGRADING.md](https://github.com/apache/ofbiz-plugins/blob/trunk/UPGRADING.md)
in the ofbiz-plugins
+ repository
+
+The complete list of pull requests that change or remove a public API is in
the "API changes" section of the
+[release notes](https://github.com/apache/ofbiz-framework/releases) GitHub
generates for each release, from the
+`api-change` label. The notes below explain what to do about the changes that
need action, and also cover the few
+that were committed without a pull request.
+
+When a pull request changes or removes a public API, add its entry here (or in
the applications or plugins file) in
+the same pull request.
+
+## Upgrading from 24.09 to the next major release (trunk)
+
+### Environment
+
+* Gradle 9 replaces Gradle 8. Run `gradle/init-gradle-wrapper.sh` (or
`init-gradle-wrapper.ps1`) again to get the
+ new wrapper.
+* The embedded Tomcat moves from 9 to 11, and with it from Java EE (`javax.*`)
to Jakarta EE 11 (`jakarta.*`):
+ Servlet 6.1, Jersey 4 and Spring 7
([OFBIZ-12989](https://issues.apache.org/jira/browse/OFBIZ-12989),
+ [#2428](https://github.com/apache/ofbiz-framework/pull/2428)). See "Custom
code" below.
+* Groovy moves from 3 to 6, and its Maven group from `org.codehaus.groovy` to
`org.apache.groovy`
+ ([#2417](https://github.com/apache/ofbiz-framework/pull/2417)).
+* Derby support is removed and H2 is the default embedded database
+ ([#1221](https://github.com/apache/ofbiz-framework/pull/1221)). If you ran
OFBiz on Derby, export your data with
+ the entity export tools on 24.09 and import it into H2 or an external
database after the upgrade.
+
+### Configuration
+
+* `entityengine.xml`: the `localderby*` datasources and the `derby` field type
are removed; use the `localh2*`
+ datasources instead. `fieldtypederby.xml`, `runtime/data/derby.properties`
and the `jdbc-password.derby-*` keys are
+ gone ([#1221](https://github.com/apache/ofbiz-framework/pull/1221)).
+* `web.xml` of custom webapps: switch to the Jakarta EE namespace and schema,
and remove the
+ `org.apache.ofbiz.webapp.control.CacheFilter` filter, which no longer exists
+ ([#2482](https://github.com/apache/ofbiz-framework/pull/2482)).
+* `log4j2.xml`: the `OFBizDynamicThresholdFilter` and the
`packages="org.apache.ofbiz.base.log4j"` attribute are
+ removed; a custom `log4j2.xml` that still uses them fails to load
+ ([#2426](https://github.com/apache/ofbiz-framework/pull/2426)).
+* `controller.xml`: the `http` view handler
([#2210](https://github.com/apache/ofbiz-framework/pull/2210)) and the
+ `screenxls` view handler
([#1973](https://github.com/apache/ofbiz-framework/pull/1973)) are removed. Use
`screenxlsx`
+ for spreadsheets.
+* Screen, form, grid, menu and tree locations must be `component://`
locations. To load them from a plain file path,
+ set `allowFilePaths` in `security.properties`
+ ([#1650](https://github.com/apache/ofbiz-framework/pull/1650)).
+* REST: services marked `export="true"` are no longer published as REST
endpoints. Declare the endpoints you need in a
+ `*.rest.xml` file in your component's `api` directory, as described in the
rest-api component documentation
+ ([#1609](https://github.com/apache/ofbiz-framework/pull/1609)). The rest-api
component now lives in
+ `framework/rest-api`, so remove `plugins/rest-api` from your checkout
+ ([#1357](https://github.com/apache/ofbiz-framework/pull/1357)).
+* Service definitions: the `action` attribute of `<service>` is removed from
`services.xsd`
+ ([#1354](https://github.com/apache/ofbiz-framework/pull/1354)).
+* Entity definitions: `encrypt="salt"` is removed; use `encrypt="true"`, which
now gives the same randomized
+ encryption ([#2055](https://github.com/apache/ofbiz-framework/pull/2055)).
+* Widgets: `<if-entity-permission>` is removed from `widget-common.xsd`
+ ([#1235](https://github.com/apache/ofbiz-framework/pull/1235)).
+* Tests: `<groovy-test-suite>` is removed from `test-suite.xsd` (commit
5a67b40971), and the `createTestReports`
+ Gradle task is replaced by `createTestReport` and `createFramedTestReport`
+ ([#1603](https://github.com/apache/ofbiz-framework/pull/1603)).
+* Security: the login services check `SECURITY_CREATE` and
`SECURITY_PWD_UPDATE` instead of `PARTYMGR_CREATE` and
+ `PARTYMGR_UPDATE` to create a user login for another party or change another
user's password. Grant the new
+ permissions to the security groups that need them
+ ([#1276](https://github.com/apache/ofbiz-framework/pull/1276)).
+
+### Custom code
+
+* Jakarta EE: replace `javax.servlet`, `javax.el`, `javax.mail`,
`javax.transaction`, `javax.ws.rs` and
+ `javax.inject` with their `jakarta.*` packages
([OFBIZ-12989](https://issues.apache.org/jira/browse/OFBIZ-12989),
+ [#1527](https://github.com/apache/ofbiz-framework/pull/1527),
+ [#2413](https://github.com/apache/ofbiz-framework/pull/2413)). Tools such as
OpenRewrite or the Eclipse
+ Transformer can do most of this. The `request` attribute of the `userLogin`
service is now a
+ `jakarta.servlet.http.HttpServletRequest`.
+* Entity engine:
+ * `Delegator` gains `createAllByBatchProcess`, and `GenericHelper` gains
`createAll`
+ ([#857](https://github.com/apache/ofbiz-framework/pull/857)); custom
implementations must add them.
+ * `EntityQuery.use` takes a `DelegatorProvider`; recompile code that calls it
+ ([#923](https://github.com/apache/ofbiz-framework/pull/923)).
+ * `GenericDelegator` does its start-up work in `initialize()`; a custom
`DelegatorFactory` must call it
+ ([#2537](https://github.com/apache/ofbiz-framework/pull/2537)).
+ * `ModelEntity` and `ModelViewEntity` lose most public constructors; use
+ `ModelEntity.createFromDatabaseMetaData`
([#2536](https://github.com/apache/ofbiz-framework/pull/2536)).
+ * Condition lists and field maps are immutable, `EntityUtil.makeFields`
takes `Object...`, and the varargs
+ `EntityFieldMap` constructor is removed
([#2462](https://github.com/apache/ofbiz-framework/pull/2462)).
+ * `EntityDataLoader.loadData` returns `long`
([#1460](https://github.com/apache/ofbiz-framework/pull/1460)).
+* Service engine:
+ * `LocalDispatcher` gains `runAsyncTracked`
([#904](https://github.com/apache/ofbiz-framework/pull/904)) and
+ `initDispatchContext` (commit b3ff76a0a8,
[OFBIZ-13153](https://issues.apache.org/jira/browse/OFBIZ-13153)).
+ * `ModelService` validation methods take a `LocalDispatcher`
+ ([#869](https://github.com/apache/ofbiz-framework/pull/869)), and
`getAction`/`setAction` are removed
+ ([#1354](https://github.com/apache/ofbiz-framework/pull/1354)).
+ * `ServiceUtil.getPartyIdCheckSecurity` is removed
([#1260](https://github.com/apache/ofbiz-framework/pull/1260)).
+ * In Groovy services, `makeValue` returns a `GenericValue`, and `success`
and `error` return a `Map`
+ ([#2096](https://github.com/apache/ofbiz-framework/pull/2096)).
+* Security:
+ * A custom `Security` implementation is registered through the new
`SecurityProvider` SPI instead of
+ `Security.setDelegator`
([#2477](https://github.com/apache/ofbiz-framework/pull/2477)).
+ * `SSLUtil` takes a trust `KeyStore` instead of a boolean, and the
accept-any-certificate options of `SSLUtil`,
+ `HttpClient` and `URLConnector` are removed
([#2190](https://github.com/apache/ofbiz-framework/pull/2190)).
+ * `DesCrypt` and the legacy `EntityCrypto` and `HashCrypt` formats are
removed
+ ([#2167](https://github.com/apache/ofbiz-framework/pull/2167)). See "Data"
below.
+ * `JWTManager.validateToken` takes a `Delegator`, and `getJWTKey` is removed
+ ([#918](https://github.com/apache/ofbiz-framework/pull/918)).
+ * `UtilCodec.encodeUrl(String, Map)` and `SecuredUpload.isValidText(String,
List, boolean)` are removed
+ ([#2367](https://github.com/apache/ofbiz-framework/pull/2367)).
+* Widgets and rendering:
+ * Several model classes are final or have restricted constructors: forms
+ ([#2485](https://github.com/apache/ofbiz-framework/pull/2485),
+ [#2483](https://github.com/apache/ofbiz-framework/pull/2483)), screens,
menus, trees and themes
+ ([#2493](https://github.com/apache/ofbiz-framework/pull/2493)). Extend
them through the widget XML instead.
+ * The visitors and renderers gain abstract methods for the date range picker
+ ([#879](https://github.com/apache/ofbiz-framework/pull/879)) and verbatim
FreeMarker
+ ([#2334](https://github.com/apache/ofbiz-framework/pull/2334)), and the
FreeMarker rendering methods take a
+ `Locale` ([#933](https://github.com/apache/ofbiz-framework/pull/933)).
+ * The macro renderers no longer compile strings as templates
+ ([#2334](https://github.com/apache/ofbiz-framework/pull/2334),
+ [#2330](https://github.com/apache/ofbiz-framework/pull/2330)).
+ * The HTML menu and tree renderers are removed; use the macro renderers
+ ([#2478](https://github.com/apache/ofbiz-framework/pull/2478)).
+ * `LookupField.getTargetParameterList` is removed
([#2461](https://github.com/apache/ofbiz-framework/pull/2461)).
+ * `UelFunctions.getFunctionMapper` returns `UelFunctions.Functions`, which
is final, and `setFunction` is removed
+ (commit c7f1ea4d18,
[OFBIZ-13372](https://issues.apache.org/jira/browse/OFBIZ-13372)).
+* REST: `OpenApiUtil`, `OFBizApiConfig`, the REST `Error` response and the
authentication and OpenAPI resources
+ changed signatures, and the classes behind `export="true"` endpoints are
removed
+ ([#1568](https://github.com/apache/ofbiz-framework/pull/1568),
+ [#1575](https://github.com/apache/ofbiz-framework/pull/1575),
+ [#1609](https://github.com/apache/ofbiz-framework/pull/1609),
+ [#1675](https://github.com/apache/ofbiz-framework/pull/1675),
+ [#1790](https://github.com/apache/ofbiz-framework/pull/1790),
+ [#2474](https://github.com/apache/ofbiz-framework/pull/2474)).
+* Other framework classes:
+ * minilang simple-map operations
([#2499](https://github.com/apache/ofbiz-framework/pull/2499)).
+ * `ArtifactInfoFactory`
([#2504](https://github.com/apache/ofbiz-framework/pull/2504)).
+ * `JmsListenerFactory`
([#2517](https://github.com/apache/ofbiz-framework/pull/2517)).
+ * the temporal expressions
([#2518](https://github.com/apache/ofbiz-framework/pull/2518)).
+ * `FlexibleServletAccessor`, `RecordIterator` and `ConfigXMLReader`
+ ([#2498](https://github.com/apache/ofbiz-framework/pull/2498)).
+ * the null entity sentinels
([#2535](https://github.com/apache/ofbiz-framework/pull/2535)).
+ * `OfbizUrlBuilder`
([#841](https://github.com/apache/ofbiz-framework/pull/841)).
+ * `UtilHttp.getMultiPartParameterMap`
([#2429](https://github.com/apache/ofbiz-framework/pull/2429)).
+ * `FindServices.createConditionList`
([#860](https://github.com/apache/ofbiz-framework/pull/860)).
+ * the JUnit suite wrapper
([#1648](https://github.com/apache/ofbiz-framework/pull/1648)).
+ * the image classes, now on jdom2
([#819](https://github.com/apache/ofbiz-framework/pull/819)).
+ * the unused members removed by
[#2482](https://github.com/apache/ofbiz-framework/pull/2482).
+
+### Themes
+
+These apply to custom themes and to themes that override the common-theme
macro libraries:
+
+* `renderTextField` gains `type`, `pattern`, `required`, `step`, `min` and
`max` parameters, and `renderAsterisks`
+ drops `requiredStyle`
([#862](https://github.com/apache/ofbiz-framework/pull/862),
+ [#965](https://github.com/apache/ofbiz-framework/pull/965)).
+* `renderScreenletBegin` gains a `screenHeader` parameter
([#1342](https://github.com/apache/ofbiz-framework/pull/1342)).
+* The theme header no longer gets `person` and `partyGroup`, and
`defaultOrganizationPartyGroupName` is renamed
+ `defaultOrganizationName`
([#1270](https://github.com/apache/ofbiz-framework/pull/1270)).
+* JavaScript libraries come from npm, so the `/common/js/jquery/...` paths are
gone
+ ([#1146](https://github.com/apache/ofbiz-framework/pull/1146)), as are the
`moment-timezone` files
+ ([#879](https://github.com/apache/ofbiz-framework/pull/879)). jQuery moves
from 3 to 4, which removes deprecated
+ jQuery APIs.
+* The `ServiceNotification` email screen moves to
`component://common/widget/EmailScreens.xml`
+ ([#1398](https://github.com/apache/ofbiz-framework/pull/1398)).
+
+### Data
+
+* Encrypted fields: values written with the older cipher configuration still
decrypt, but run the `reencryptFields`
+ service after the upgrade to rewrite them with the current one
+ ([#2055](https://github.com/apache/ofbiz-framework/pull/2055); see "Entity
field encryption" in the security
+ documentation).
+* `EntityCrypto` no longer reads values and keys in the salted-base64 and
legacy hash formats that came before its
+ Shiro-based handler, nor keys encrypted with `DesCrypt`
+ ([#2167](https://github.com/apache/ofbiz-framework/pull/2167)). If your
database was created by an old OFBiz
+ release, make sure it holds none of these before you upgrade.
+* New framework entities, created automatically at start-up: `JobTracker`,
`TrackedJobResult` and their views,
+ `MailSmtpConfig`, `MailDkimConfig`, `SecretAuditLog` and `ShortenedPath`.
+* The OLAP/BI entity group (`EntityGroup` 6800) is removed from the seed data
+ ([#2479](https://github.com/apache/ofbiz-framework/pull/2479)).
diff --git a/applications/UPGRADING.md b/applications/UPGRADING.md
new file mode 100644
index 0000000000..14d9877bc1
--- /dev/null
+++ b/applications/UPGRADING.md
@@ -0,0 +1,83 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Upgrading the OFBiz applications
+
+This file lists what you need to change in your configuration, custom code and
data when you upgrade the OFBiz
+applications to a new major release. Start with the framework notes in
[../UPGRADING.md](../UPGRADING.md), which also
+cover the environment. The application entity and field changes, with their
migration services, are in
+[datamodel/DATAMODEL_CHANGES.adoc](datamodel/DATAMODEL_CHANGES.adoc).
+
+When a pull request changes or removes a public API of an application, add its
entry here in the same pull request.
+
+## Upgrading from 24.09 to the next major release (trunk)
+
+### Removed integrations
+
+These integrations were removed with their services, entities, seed data,
properties, screens and requests. There is
+no replacement in OFBiz; a project that still uses one has to keep its own
copy.
+
+| Integration | Pull request |
+|---|---|
+| Payment gateways: Authorize.Net, ClearCommerce, CyberSource, Eway, Orbital,
PayPal, Payflow Pro, PCCharge, RiTA, SagePay, SecurePay, WorldPay |
[#1371](https://github.com/apache/ofbiz-framework/pull/1371) |
+| Shipping carriers: DHL, FedEx, UPS, USPS |
[#1335](https://github.com/apache/ofbiz-framework/pull/1335),
[#1377](https://github.com/apache/ofbiz-framework/pull/1377) |
+| Taxware and ZIPsales tax |
[#1380](https://github.com/apache/ofbiz-framework/pull/1380) |
+| ValueLink gift cards |
[#1149](https://github.com/apache/ofbiz-framework/pull/1149) |
+| eBay seed data (`EBAY_SALES_CHANNEL`, `EXT_EBAY`, `PCCT_EBAY_ROOT`) |
[#1493](https://github.com/apache/ofbiz-framework/pull/1493) |
+| BIRT order report events |
[#2476](https://github.com/apache/ofbiz-framework/pull/2476) |
+
+### Services
+
+* `productAvailabalityByFacility` and its request are removed, and the
mini-lang file
+ `component://order/minilang/order/OrderServices.xml` is replaced by Groovy
+ ([#870](https://github.com/apache/ofbiz-framework/pull/870)).
+* `findOrders` no longer takes `cardNumber`, since an encrypted field can't be
searched by exact match
+ ([#2055](https://github.com/apache/ofbiz-framework/pull/2055)).
+* `createBOMAssoc` no longer returns `errorMessage`
([#1531](https://github.com/apache/ofbiz-framework/pull/1531)).
+* `createCustomTimePeriod` no longer takes `organizationPartyId` (commit
281f31bed0,
+ [OFBIZ-13418](https://issues.apache.org/jira/browse/OFBIZ-13418)).
+
+### Custom code
+
+* `EntityPermissionChecker` moves from `org.apache.ofbiz.entityext.permission`
to
+ `org.apache.ofbiz.content.permission`
([#1235](https://github.com/apache/ofbiz-framework/pull/1235)).
+* `ShoppingCart`:
+ * the contact mechanism methods allow several contact mechanisms per purpose
and have new signatures (commit
+ e67062a6ab,
[OFBIZ-13199](https://issues.apache.org/jira/browse/OFBIZ-13199)).
+ * `ensureItemsQuantity` is removed (commit 45f6a3e247,
+ [OFBIZ-13318](https://issues.apache.org/jira/browse/OFBIZ-13318)).
+* `ProductConfigWrapper.ConfigItem` and `ConfigOption` are static nested
classes with new constructors, and the
+ `BOMNode` tree methods changed
([#2509](https://github.com/apache/ofbiz-framework/pull/2509)).
+* Manufacturing:
+ * `MrpServices.processBomComponent` takes a `facilityId`
([#1474](https://github.com/apache/ofbiz-framework/pull/1474)).
+ * `ProposedOrder.calculateStartDate` changed
([#1427](https://github.com/apache/ofbiz-framework/pull/1427)).
+ * `TechDataServices.dayStartCapacityAvailable` changed
([#896](https://github.com/apache/ofbiz-framework/pull/896)).
+* The carrier and gateway classes listed under "Removed integrations" are
gone, together with
+ `ShipmentServices.quickScheduleShipmentRouteSegment`, the carrier parameters
of `WeightPackageSession`,
+ `UtilValidate.isValueLinkCard` and
`CatalogWorker.getCatalogTopEbayCategoryId`.
+
+### Data
+
+* Run `migratePersonMaritalStatusType` to move `Person.maritalStatusEnumId`,
now `oldMaritalStatusEnumId`, to the
+ new `MaritalStatusType`
([OFBIZ-13329](https://issues.apache.org/jira/browse/OFBIZ-13329)). The
`MARITAL_STATUS`
+ enumerations are removed.
+* `FinAccount.finAccountCode` is no longer encrypted. Run
`decryptFinAccountCodes` to turn the existing values back
+ into plain text
([#2055](https://github.com/apache/ofbiz-framework/pull/2055)).
+* The tables of the removed entities are not dropped. Drop them once you no
longer need their data; the list is in
+ [datamodel/DATAMODEL_CHANGES.adoc](datamodel/DATAMODEL_CHANGES.adoc).
diff --git a/applications/datamodel/DATAMODEL_CHANGES.adoc
b/applications/datamodel/DATAMODEL_CHANGES.adoc
index 024a6486db..834951b948 100644
--- a/applications/datamodel/DATAMODEL_CHANGES.adoc
+++ b/applications/datamodel/DATAMODEL_CHANGES.adoc
@@ -32,12 +32,32 @@ The following file contains information about the data
model changes in the Apac
*Added new entities*
. MaritalStatus
. MaritalStatusType
+. MrpRunLog
+. WorkEffortInvRes
+
+*Added new view entities*
+. ProductAndAssocTo
+. WorkEffortInvResAndItem
+. WorkEffortInventoryAssignAndItem
+
+*Removed 17 entities*
+
+. PaymentGatewayAuthorizeNet, PaymentGatewayClearCommerce,
PaymentGatewayCyberSource, PaymentGatewayEway,
+ PaymentGatewayOrbital, PaymentGatewayPayPal, PaymentGatewayPayflowPro,
PaymentGatewaySagePay,
+ PaymentGatewaySecurePay, PaymentGatewayWorldPay (d278d49b)
+. ShipmentGatewayDhl, ShipmentGatewayFedex, ShipmentGatewayUps,
ShipmentGatewayUsps (672b6d02)
+. ValueLinkKey (b7c56b75)
+. ZipSalesRuleLookup, ZipSalesTaxLookup (a07c838c)
+
+The tables of removed entities are not dropped; drop them once their data is
no longer needed.
=== Field Changes
[cols="<,^,^,^,>",options="header",]
|=======================================================
|Entity |Field |Action |IsPK |Revision
| Person | maritalStatusTypeId | Added | No | 109c496e
+| PayPalPaymentMethod | expressCheckoutToken | Removed | No | d278d49b
+| FinAccount | finAccountCode | Modified (no longer encrypted) | No | cae2bb65
|=======================================================
@@ -45,6 +65,9 @@ The following file contains information about the data model
changes in the Apac
1. Migration service *migratePersonMaritalStatusType* is implemented to
migrate the
*oldMaritalStatusEnumId* field to *maritalStatusTypeId* on entity
*Person*. +
(More detail at
https://issues.apache.org/jira/browse/OFBIZ-13329[OFBIZ-13329])
+2. Migration service *decryptFinAccountCodes* is implemented to turn the
encrypted
+ *finAccountCode* values of entity *FinAccount* back into plain text. +
+ (More detail at
https://issues.apache.org/jira/browse/OFBIZ-13599[OFBIZ-13599])
== Changes with OFBiz 24
