Release Notes
Abstract
Release notes for IBM Financial Transaction Manager for Digital Payments 3.2.12 Multiplatforms
Content
- Before installation
- Product documentation
- General instructions
- Installation
- Deployment
- Installing and configuring a server for IBM WebSphere Application Server Liberty
- Common Across Releases
- Supported Early Warning Services (EWS) notifications and SOAP requests
- 3.2.12 Release
Before installation
System requirements
Downloading the product
For information about how to download IBM Financial Transaction Manager for Digital Payments for Multiplatforms see the download document for IBM Financial Transaction Manager for Digital Payments for Multiplatforms 3.2.12.Product documentation
- Release information (this document)
- System requirements website
- Fix list (key defects fixes in this release)
- Financial Transaction Manager online product documentation
- Entitled documentation fix pack (download from Fix Central)
- Mapping Specs - these documents are provided in the entitled documentation fix pack
- Resources (support links for this and other releases of this offering)
Data Setup Utility
The following documentation describes the data setup utility (DSU) and the import and export workbooks:
- DSUmigration_v3.2.12.pdf
- DSUMigrationBR_v3.2.12.pdf
These documents are provided in the entitled documentation fix pack.
Database migration
For database migration instructions, refer to the migration instructions in {Install location}\shared\vnnn\pfs\Database\db2\{os}\doc
Transaction Server Scheduler XML
The following documentation describes the changes to the scheduler XML for the Transaction Server component:
- TransactionServerSchedulerChanges_v3.2.12.pdf
These documents are provided in the entitled documentation fix pack.
Web Services
The following documentation describes the new web services, which are implemented by using IBM WebSphere Application Server Liberty:
- IBM_FTM_Web_Services_v3.2.12.0.pdf
These documents are provided in the entitled documentation fix pack.
General instructions
Installation
- Start IBM Installation Manager.
- Add the location of the repository that contains the installation package:
- Select File > Preferences.
- Click Add Repository.
- Browse to the directory that contains the repository .zip file and select the file. Click Open and then OK.
- Click Test Connections and then OK.
- Click OK.
- Install the FTM product installation files to your installation directory:
- On the main pane, click Update.
- Select IBM Financial Transaction Manager for Digital Payments, IBM Financial Transaction Manager for Check Services, IBM Financial Transaction Manager for Corporate Payment Services, or IBM Financial Transaction Manager for High Value Payments, and then click Next.
- Select the fix pack or interim fix and then click Next.
- Follow the rest of the prompts.
- Confirm that the "Update packages" page shows success.
Deployment
- Do the database migration. Refer to the Database migration section in this document.
- Note: The runtime components can’t be running during the database migration.
- Note: Files can continue to be delivered to the Gateway inbound source folder.
- J2SE components: The installation overlays the J2SE applications, so no special migration instructions are needed. Restarting those applications updates them with the fixes.
- WebSphere Application Server components: You can use the Automated Deployment Utility (ADU), manually upgrade (refer to the update instructions in each WebSphere Application Server component doc folder), or, in a WebSphere Application Server Network Deployment configuration, use the Deployment Manager.
Note: Refer to "WebSphere Application Server 9.0.x update issue" in "Common Across Releases" > "Known Issues".- All WebSphere servers must be restarted after all the components were updated.
- For an interim fix, refer to the fix list for the modules to deploy. Note: Interim fixes are meant to be deployed on an existing WebSphere Application Server profile deployment. If you are using a new WebSphere Application Server profile and already installed the interim fix onto the prior installation, you must do two deployment passes. The first pass is to do the initial, full product deployment. The second pass is to do those components that are affected by the interim fix.
- Update your Transaction Server Scheduler.xml file. Refer to the Transaction Server Scheduler XML section in this document. Note: Updating the scheduler file might not be required for your installation.
- Refer to the release-specific section for any changes that might affect your installation.
- Start your runtime components.
- If you are using the Data Setup Utility (DSU) worksheets capability for managing your data, update your worksheets. For more information, see the Data Setup Utility section in this document.
Locate the compressed file for WebSphere Application Server Liberty that is stored in the following path:
<installation directory>/ftm/vxxx/run/liberty
Where xxx = represents current FTM version that is running. For example, 3212.
Decompress the file in your preferred path: <liberty-install-directory>. For example, /opt/wlp/.
Follow the following steps to create and configure the server:
- Create your server with <liberty-install-directory>/bin/server create PFSServer.
- Modify the server.xml.template file located in FTM installation path <installation directory>/shared/vxxx/pfs/WebServices/Liberty/PFS with config values for your install (refer to the following list of things that need to be modified).
- Rename that file server.xml
- Copy server.xml and jvm.options into <liberty-install-directory>/usr/servers/PFSServer.
- Start your server with <liberty-install-directory>/bin/server start PFSServer --clean (--clean is optional).
Things that need to be modified in the server.xml.template depending on environment details:
- Db2 installation location, database name, and port.
- IBM MQ installation location, queue manager name, user, password, and port.
- The db2admin user and password.
- Set currentPackagePath, currentFunctionPath, and currentSchema to your schema name.
- Set the password for the FTM administrator ID, which is usually fxhadmin.
- You must ensure that you create a server or update an existing server to run the new version of the IBM WebSphere Liberty RESTful web services. For more information, see https://www.ibm.com/docs/SSRH46_3.2.12/gpyiybrinstlibty.html
| Back to contents |
Common Across Releases
|
None
| Back to contents |
Supported Early Warning Services (EWS) notifications and SOAP requests
|
Version 3.2.12
The following is a list of supported EWS notifications and supported EWS SOAP requests.
| Supported EWS notification | Version |
| OnCustomerChangeNotification | 4.2 |
| OnPaymentProfileStatusChangeNotification | |
| OnNewPaymentNotification | 4.0 |
| OnTokenStatusChangeNotification | 4.3 |
| OnNewPaymentRequestNotification | 4.2 |
| OnOrganizationsChangeNotification | 4.0 |
| OnPaymentRequestChangeNotification | 2.4 |
| OnContactMethodWarningNotification | 4.3 |
| OnPaymentStatusChangeNotification | 4.3 |
| Supported EWS requests | Version |
| AddPaymentRequest | 4.1 |
| ChangePaymentRequestRequest | 4.0 |
| ChangePaymentStatusRequest | 4.6 |
| DeletePaymentProfileRequest | |
| GetCustomerEventDetailsRequest | 4.0 |
| GetOrganizationsRequest | 4.0 |
| GetPaymentRequest | 4.3 |
| GetPaymentRequestDetailsRequest | 4.2 |
| GetPendingActivityForTokenRequest | 3.2 |
| GetTokenHistoryRequest | 4.3 |
| GetTokenStatusRequest | 4.2 |
| RegisterTokenRequest | 4.5 |
| RemoveTokenRestrictionRequest | 4.2 |
| RequestPaymentsRequest | 4.2 |
| RestrictTokenRequest | 4.2 |
| UnregisterTokenRequest | 4.2 |
| UpdateBusinessPaymentProfileRequest | 4.0 |
| UpdatePersonalPaymentProfileRequest | 4.0 |
| ValidateRecipientRequest | 4.2 |
| Supported EWS RESTful Requests | |
| zpss/v1/active-profiles | |
| zpss/v1/available-profiles |
| Back to contents |
3.2.12.0
|
Compatibility Matrix
Because the development of releases and interim fixes for maintenance are done in parallel, a later release might not contain every interim fix that was created for an earlier release. The following table shows which releases and interim fix levels can be successfully upgraded to version 3.2.12.0.
In the following table, the "If you're on version" column shows you the releases that can be upgraded successfully. The latest release or interim fix level that can be upgraded for each release is shown in the "To successfully upgrade to 3.2.12.0, your version must be no higher than version" column. If the release that you are upgrading from is at an interim fix level higher than the release or fix level shown in the right column, you can't upgrade the release without losing some changes. The upgrade needs to occur at the next release.
For more information about the individual changes in a release or interim fix, see the fix list for this version.
| If you’re on version | To successfully upgrade to 3.2.12.0, your version must be no higher than version |
| 3.0.2.0 | 3.0.2.0 interim fix 2 |
| 3.0.2.1 | 3.0.2.1 interim fix 23 |
| 3.0.4.0 | 3.0.4.0 interim fix 3 |
| 3.0.4.1 | 3.0.4.1 interim fix 1 |
| 3.2.0.0 | 3.2.0.0 interim fix 1 |
| 3.2.0.1 | 3.2.0.1 interim fix 2 |
| 3.2.1.0 | 3.2.1.0 interim fix 3 |
| 3.2.2.0 | 3.2.2.0 interim fix 5 |
| 3.2.2.1 | 3.2.2.1 interim fix 3 |
| 3.2.3.0 | 3.2.3.0 interim fix 5 |
| 3.2.4.0 | 3.2.4.0 interim fix 14 |
| 3.2.5.0 | 3.2.5.0 interim fix 6 |
| 3.2.6.0 | 3.2.6.0 |
| 3.2.6.1 | 3.2.6.1 interim fix 6 |
| 3.2.7.0 | 3.2.7.0 interim fix 2 |
| 3.2.8.0 | 3.2.8.0 |
| 3.2.8.1 | 3.2.8.1 interim fix 4 |
| 3.2.9.0 | 3.2.9.0 interim fix 10 |
| 3.2.9.1 | 3.2.9.1 interim fix 1 |
| 3.2.10.0 | 3.2.10.0 interim fix 6 |
| 3.2.10.1 | 3.2.10.1 interim fix 2 |
| 3.2.11.0 | 3.2.11.0 interim fix 1 |
| 3.2.11.1 | 3.2.11.1 interim fix 1 |
Known issues
- Issues with Request For Payment web service
For requests that use the BldgNb, in <Dbtr>, <UltmtDbtr>, <Cdtr>, <UltmtCdtr>, the data is not sent to TCH. This issue limits the ability to use the BldgNb data.
- WebSphere Application Server 9.0.x update issue
Automated Deployment Utility workaround:
The interim fix components to update need to be first uninstalled. The tokens file, for example pfs_deploy.xml, contains those interim fix components to update. These components appear in the <install> </install> section. You also need to add these same components in the <uninstall> </uninstall> section.
Before the console WAR modules are updated, stop the FrameworkUI_EAR application, and then proceed as normal. The engine modules can be updated as normal.
- OFAC Simulator not working
If the sample control file is updated, the OFAC Simulator fails due to a missing required attribute, Business Concept.
- Potential issue with Cancel Request For Payment web service
When the Log Transaction setting on the "Request To CSM" Channel configuration is updated to Yes (Y) in FTM for Immediate Payments, the Cancel Request For Payment Web Service could fail when it tries to correlate transactions. It is recommended that the Log Transaction setting for the "Request To CSM" Channel configuration remain set to No (N).
- SchedulePaymentModel issue
- Held files might be incorrectly flagged as duplicate.
- Outbound physical transmissions page might provide more restrictive results to users without entitled access
When a restrictive entitlement is configured, users must be configured to have that entitlement before they can view the entitled data. The outbound physical transmissions page incorrectly restricts the data based on the inbound data fields. So, nonentitled users have a more restrictive view of the outbound physical transmission page.
Feature changes
Overview
Sometimes, internal issues occur that require FTM to "pause" outbound API requests to identify the cause of the problem. After the problems are fixed FTM work can be resumed. Operators pause an application by using the Control Center (CC) Pause/Resume UI.
Steps to pause FTM outbound API requests




Steps to set the pause FTM count for outbound API requests



Steps to resume FTM outbound API requests



FTM Application changes
- The Pause/Resume messages are sent using the publish/subscribe model.
- The only application currently subscribing to Pause switch is Zelle Outbound.
- If the application is paused with a count, the application must query the “pause count” in the database. If the count is greater than zero, and the participant list is empty or participant calling the API is in the allow list, the count is decremented, and application processes the message as normal. If the count is 0, the application refuses the message. If the count is greater than 0, but the participant is not in the allow list of participant Ids, the application refuses the message.
Funds Movement “Out of Sync” Retry Automation
When FTM process Zelle payments (both origination and received), part of the process is to call the Financial Institution’s accounting/Funds movement services to either transfer funds TO the end user’s account FROM the FI’s Zelle settlement account OR to transfer funds FROM the end user’s account TO the FI’s Zelle settlement account. The Zelle funds movement process uses User Exit entry point interfaces that are supplied to the FIs. The FI supplies the backend logic to interface to their accounting system to correctly transfer/reverse funds.
If the FI’s Funds Transfer UX does not provide a definitive response that the requested funds transfer has completed successfully or failed (insufficient funds, account closed, etc.), then FTM needs to ensure that indeterminant responses (runtime exceptions, time outs, etc.) are not simply processed as normal/known failures which could cause FTM to reflect inconsistent values for the state of the funds transferred/reversed flags for the transaction.
When the Zelle application encounters any return condition from the FI’s User Exit except for a definitive Success/Fail, the payment’s Funds Transferred/Funds Reversed (depending on the direction of the funds transfer) field will be set “Error” instead of Failed.
Any received real time payment that encounters this condition will have its EWS status updated to Accept Without Posting (AWP) until the payment’s funds transfer status can be clearly determined.
The Out of Sync Funds Movement retry process will tie the Out of Sync Zelle payments into FTM’s Retry framework to facilitate automatic retries of the funds movement process as they occur and attempt to determine the state of the fund’s movements automatically. The retry process will clearly denote the retries as they occur in the transaction history of the payment. The retry process will continue to automatically retry the funds movement for the payment via new Funds Transfer User Exit retry API methods. The FI will be responsible for correctly adding its own Funds Movement retry logic to these APIs to correctly determine the status of the fund’s movement within the FI.
Zelle Funds Transfer User Exit updates
There are 2 new API methods that have been added to the com.ibm.fxh.zel.ui.fundstransfer.UserTransferFundsInterface.
They are:
public ZelleUserExitResult retryTransferFundsToSettlement(CXCPayment, CXCOrganizationDataView, Boolean, int retryCount)
public ZelleUserExitResult retryTransferFundsFromSettlement(CXCPayment, CXCOrganizationDataView, Boolean, int retryCount)
***The Financial Institution is responsible for adding their own logic to these methods to ensure correct processing of any funds movement retries.***
Zelle Funds Movement OOS retries
The Zelle Funds Movement OOS payments will use the existing FTM Retry framework by assigning a known error code (configured in Administration -> Components -> Zelle -> General Properties and the “Funds Transfer OOS Error Code” property) to the payment that has an indeterminate funds transferred/reversed status. There are new Business Rules retry configuration details that will dictate how often/how long a payment with the assigned error code and the specific retry category (FUNDSTXFR_OOS) should be retried. The existing Services Framework RetryTask should be configured with the specific FUNDSTXFR_OOS category and ZELLE payment scheme. The RetryTask should be scheduled as desired by the customer. On execution, the RetryTask will cause the Zelle payments that have an indeterminate funds movement status to be retried using the new Funds Transfer User Exit retry API methods. The process will continue until the Out of Sync payment’s funds transfer/reverse status (either success or failure) is determined or the retry attempts are exhausted.
Transactions Grid UI
A new multi-select “Retry Funds Movement” perform action menu option has been added to the transactions grid screen. This option will allow multiple selections if all that are selected are Zelle payments (for now) and the “Funds Transferred” or “Funds Reversed” payment fields are set to Error. This will allow manual resync actions for permissioned users outside the automated retry framework.
Add “Owner” as an entitlement criterion
A new entitlement criterion of “Owner” has been added along with the existing Global Bank Id. The new Owner criteria is be able to be used with other entitlement criteria and can be applied to each entitlement in combination or separately as they see fit.
The Owner entitlement will only support “equal to”/”=” or “not equal to”/”!=” entitlement operator values.
This new criterion will apply to the existing “Global UI Runtime Grid” resource. The “Global UI Runtime Grid” resource will contain/effect ALL the following UI grid screens:
• Physical Transmissions (Inbound/Outbound)
• Inbound Transmissions
• Inbound Batches
• Processing Batches
• Inbound Transactions
• Outbound Transmissions
• Outbound Batches
The Owner entitlement criteria is not supported for Check, NACHA or Zelle payments. For all other payment schemes, the logic to assign “ownership” will be controlled by the Financial Institution via custom logic applied to their application.
Performance improvements for Distribution Engine
The existing core property, 'TCH Payment Mapping count', provided for allowing multiple threads to perform the mapping process for incoming batch having a size greater than the value assigned to this property. This was limited to TCH payment standard batches only. This has now been extended to all payment types (except check) and the property has subsequently been renamed to 'Payment Mapping count'. Also, this property previously had a default value of 50, which has now been changed to 0, effectively disabling this property by default.
Then, for outbound transmissions having FTM Workflow transmission format. Previously, these outbound transmissions would not be built until a build/release request was issued. With this release, the FTM base artifacts related to a given outbound transmission will be built after each mapping operation has completed. This is accomplished by having the distribution mapper issue one or more batch build MQ request messages to the distribution file queue thus allowing this processing to be multi-threaded.
Improvements for validation rule set
Starting from 3.2.12, two new checkboxes were added to UI pages 'Add Batch / ICL Rule Set' page and the 'Batch / ICL Rule Details' page. The checkboxes are 'Future Business Days' and 'Past Business Days'.'Future Business Days'- During future date validation, business days are used instead of calendar days to determine a valid future date when comparing an entry date with the number of max allowed days.
'Past Business Days' - During past date validation, business days are used rather than calendar days to determine a valid past date when comparing an entry date with the number of max allowed days.
Perform Actions Dialog
The Perform Actions dialog renders the dynamic configured parameters for each defined action for the Base application. In addition, some existing menu actions such as Transmission Accept, Reject or Batch Accept, Reject are also now merged onto the new Perform Actions dialog. The merged actions will also render the necessary parameters based on the configuration.
This new Perform Actions dialog is applied to Inbound Transmission, Inbound/Processing Batches and Inbound Transactions screens.
The configurations are in Base application’s configuration DSU spreadsheet. For example, the Sample[ReferenceApp]Configuration.xlsx has a new Perform Action Configuration sheet that lists all the actions that require the parameters. If the actions are not defined in the sheet, that action does not require the parameters.
The configuration is an XML format that can be loaded by DSU at the time of initial deployment.
The new dialogs can be accessed from the Grid screen action icon for each UOW screen.

The following is a sample XML that can be configured.
Note that the key to retrieve the action parameters are the Base application name, action name, Base status and Base subtype.
The Base action parameter (ActionParameter element that is not associated with the group) will be displayed under the Perform Action dialog’s action name.
If any action parameters are associated with the group, they will be displayed under a separate tab.
ActionParameter attributes
|
Attributes |
Description |
|
name |
The unique name of the parameter. |
|
type |
The type of the field. The valid one is XML supported type. E.g. Integer, decimal, string, date, datetime, boolean and etc. |
|
length |
The optional length field. If the type is either date or datetime, the length is not required since the long representation of the time value is used instead. |
|
displayOrder |
The optional order of display of fields. If the same order is found, then it will resort based on the name. |
|
required |
The required indicator. |
|
displayName |
The label of the field of the parameter. This is optional. If not used, the system assumes the NLS key is defined. |
|
description |
The help description of the field of the parameter. This is optional. If not used, the system assumes the NLS key is defined. |
|
regEx |
The optional validation rule to enforce the validity of the value entered by the client. If no regEx is used, the minimum validation based on the length or type will be performed. |
|
Group |
The optional group name to be used to create an additional tab in the dialog. This will be useful when too many parameters are required for the selected action. |

Note the Summary Grid will differ for each UOW.
Following is the sample xml configuration for the Transaction Level Accept Action.
Note: this action might not apply to all the reference applications.
<?xml version="1.0" encoding="UTF-8"?>
<ActionParameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ActionParameters.xsd">
<ActionParameter
name="InterBankSettlementDate"
type="date"
displayOrder="1"
required="true"
regEx="\d{4}-\d{2}-\d{2}"/>
<Group name="Charge">
<ActionParameter
name="ChargesAmount"
type="decimal"
length="18"
displayOrder="1"
required="true"
regEx="^[0-9]{1,15}(?:\.[0-9]{1,2})?$"/>
<ActionParameter
name="ChargesCurrency"
type="string"
length="3"
displayOrder="2"
required="true"
default="SEK"
choices="SEK,DKK"
regEx="[A-Z]{3,3}"/>
<ActionParameter
name="ChargesAgent"
type="string"
length="11"
displayOrder="3"
required="true"
regEx="[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"/>
<ActionParameter
name="ChargesAccount"
type="string"
length="30"
displayOrder="4"
required="true"
regEx="[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"/>
</Group>
<Group name="Compensation">
<ActionParameter
name="CompensationAmount"
type="decimal"
length="18"
displayOrder="1"
required="true"
regEx="^[0-9]{1,15}(?:\.[0-9]{1,2})?$"/>
<ActionParameter
name="CompensationCurrency"
type="string"
length="3"
displayOrder="2"
required="true"
default="SEK"
choices="SEK,DKK"
regEx="[A-Z]{3,3}"/>
<ActionParameter
name="CompensationDebtorAgent"
type="string"
length="11"
displayOrder="3"
required="true"
regEx="[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"/>
<ActionParameter
name="CompensationCreditorAgent"
type="string"
length="11"
displayOrder="4"
required="true"
regEx="[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"/>
<ActionParameter
name="CompensationCreditorAccount"
type="string"
length="30"
displayOrder="5"
required="true"
regEx="[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"/>
</Group>
</ActionParameters>
NLS support rule:
For Name:
The system will search the actionParameter.[parameter name].name key first. If found, the translated label will be used.
However, if the key is not defined, it will check if the XML configuration contains the displayName. If found, it will be used.
If none of key or displayName are used, the parameter name will be used to display the name.
For Help:
The system will search the actionParameter.[parameter name].description key first. If found, the translated label will be used.
However, if the key is not defined, it will check if the XML configuration contains the description. If found, it will be used.
If none of key or description are used, the parameter name will be used to display the help.
For Tab Name:
The system will search the actionParameter.[group name].group key first. If found, the translated label will be used.
If the key is not defined for the group, the group name will be used to display the help.
Permissions Generation Process
For FTM Base applications such as SEPA, HVP and CPS will have new permissions generated when the applications are initially installed.
The process will follow the following steps.
- When installed, the FSM_RESOLUTION_ACTION table will contain a list of actions for each application depending on its UOW levels (e.g. Transmission, Batch, Transaction).
- The system will generate the permission code for each action name.
- For Transmission, Inbound/Processing Batches and Transactions screen, the permissions will be assigned based on each Base Application.
- The client will have to assign such permissions separately. Once the permissions are created base on FSM_RESOLUTION_ACTION, they will not be deleted assuming the future release will continue reusing them.

The Check, NACHA and Zelle applications do not have a corresponding Base application. Their default permission will reuse the existing permissions. They will be located under the None Base Application.

Note that some of the Transaction actions are TCH specific permissions, such as Accept Transactions, Accept And Return Transactions and Reject Transactions. Those will not be used anymore. The corresponding permissions are created under FTM IP TCH Application separately.
These old permissions, though no longer used, will remain in the system to support smooth migration. That is because the DB migration precedes the application migration. There may be a window that the old application may be used with the upgraded database and DSU.
Reference Zelle Reconciliation Process
The Zelle ReconcileTask and ZelleReconciliationFundsTransfer Services Framework Tasks were combined into a single ZelleReconciliationTask. This change minimizes the amount of event traffic that is generated during ACH settlement processing, which helps performance during these processes.
The ReconcileTask and the ZelleReconciliationFundsTransfer are deprecated. They are also packaged separately from the other Zelle related tasks in a Deprecated_Zelle_Tasks.jar file. It is suggested that you follow the new ZelleReconciliation process. However, if you do not follow the new process, you need to use the new Deprecated_Zelle_Tasks.jar file to ensure that the deprecated tasks can run correctly.
Reference changes to accommodate the new processing flow were made to the Transaction Server Scheduler.xml file that is provided (defined in the entitled documentation). If you are already using the new ZelleReconciliationTask, these changes should be equivalent to what is currently configured.
Was this topic helpful?
Document Information
Modified date:
18 July 2024
UID
ibm17033676