Customizing the configuration files in a ConfigMap

FTM supports customizing configuration files by updating the files in the ConfigMaps. All configuration files are retrieved directly from the ConfigMaps. You cannot use persistent volumes to customize configuration files.

The following table shows the ConfigMaps that are used by Transaction Server. If you modify the config.properties file for Transaction Server, delete the pod. The new pod is created with the updated configuration.

Table 1. ConfigMaps for Transaction Server
ConfigMap name Configuration file name from the artifacts container Configuration file name in the ConfigMap
<ftm-instance>-transaction-server-config configITS.properties config.properties
<ftm-instance>-transaction-server-scheduler scheduler.xml scheduler.xml
<ftm-instance>-transaction-server-listener-profile ListenerProfileReference.xml listener-profile.xml
<ftm-instance>-transaction-server-extraction-profile ExtractionProfile.xml extraction-profile.xml
<ftm-instance>-transaction-server-email-late TrackedItemLateEmail.xml tracked-item-email-late.xml
<ftm-instance>-transaction-server-email-overdue TrackedItemOverdueEmail.xml tracked-item-email-overdue.xml
<ftm-instance>-transaction-server-jaqi-config sample_jaqi.cfg jaqi-config.properties
<ftm-instance>-transaction-server-scheduler-cbprplus scheduler-fragment-cbprplus.xml scheduler-fragment-cbprplus.xml
<ftm-instance>-transaction-server-scheduler-common scheduler-fragment-common.xml scheduler-fragment-common.xml
<ftm-instance>-transaction-server-scheduler-euro1 scheduler-fragment-euro1.xml scheduler-fragment-euro1.xml
<ftm-instance>-transaction-server-scheduler-nbo scheduler-fragment-nbo.xml scheduler-fragment-nbo.xml
<ftm-instance>-transaction-server-scheduler-rix scheduler-fragment-rix.xml scheduler-fragment-rix.xml
<ftm-instance>-transaction-server-scheduler-t2 scheduler-fragment-t2.xml scheduler-fragment-t2.xml
<ftm-instance>-transaction-server-scheduler-targetdkk scheduler-fragment-targetdkk.xml scheduler-fragment-targetdkk.xml
<ftm-instance>-transaction-server-scheduler-fedwire scheduler-fragment-fedwire.xml scheduler-fragment-fedwire.xml
<ftm-instance>-transaction-server-scheduler-cpa-aft scheduler-fragment-cpaaft.xml scheduler-fragment-cpaaft.xml
<ftm-instance>-transaction-server-scheduler-nacha scheduler-fragment-nacha.xml scheduler-fragment-nacha.xml
<ftm-instance>-transaction-server-scheduler-fragment-zelle scheduler-fragment-zelle.xml scheduler-fragment-zelle.xml
<ftm-instance>-transaction-server-scheduler-tch-rtp scheduler-fragment-tchrtp.xml scheduler-fragment-tchrtp.xml
<ftm-instance>-transaction-server-scheduler-check scheduler-fragment-check.xml scheduler-fragment-check.xml
The following table shows the ConfigMaps that are used by Gateway Server. If you modify the config.properties file for Gateway Server, delete the pod. The new pod is created with the updated configuration. If the deployed solution is Check, refer to the Check specific configuration files.
Table 2. ConfigMaps for Gateway Server
ConfigMap name Configuration file name from the artifacts container Configuration file name in the ConfigMap
<ftm-instance>-gateway-server-inbound-config sample_izxconfig_inbound.properties config.properties
<ftm-instance>-gateway-server-inbound-processing-control Not available local-processing-control.xml
<ftm-instance>-gateway-server-inbound-ciff-micr-map CiffFieldMap.TBL ciff-field-map.tbl
<ftm-instance>-gateway-server-outbound-config sample_izxconfig_outbound.properties config.properties
<ftm-instance>-gateway-server-outbound-processing-control Not available local-processing-control.xml
<ftm-instance>-gateway-server-outbound-ciff-micr-map CiffFieldMap.TBL ciff-field-map.tbl
<ftm-instance>-gateway-server-inbound-check-config sample_izxconfig_inbound_check.properties config.properties
<ftm-instance>-gateway-server-inbound-check-processing-control Not available local-processing-control.xml
<ftm-instance>-gateway-server-inbound-check-ciff-micr-map CiffFieldMap.TBL ciff-field-map.tbl
<ftm-instance>-gateway-server-outbound-config sample_izxconfig_outbound_check.properties config.properties
The following table shows the ConfigMaps that are used by Business Rules. If you modify the config.properties file for a Business Rules component, the pod must be deleted. The new pod is created with the updated configuration.
Table 3. ConfigMaps for Business Rules
ConfigMap name Configuration file name from the artifacts container Configuration file name in the ConfigMap
<ftm-instance>-business-rules-manager-config pdmconfig.properties config.properties
<ftm-instance>-business-rules-server-config configBR.properties config.properties
<ftm-inst>-business-rules-server-properties override-application.properties override-application.properties
Any customization to the API server application.properies configuration file can be done by modifying the properties value to the override-application.properties file in the ConfigMap for the component. The following table shows the ConfigMap names for the components that are used by API servers.
Table 4. ConfigMap for components that are used by API servers
Component name ConfigMap name Configuration file name in the ConfigMap and artifact container
Control Center Core API <ftm-instance>-control-center-core-api-properties override-application.properties
Exceptions & Investigation engine <ftm-instance>-exceptions-investigation-engine-properties override-application.properties
External API <ftm-instance>-external-api-properties override-application.properties
Services API <ftm-instance>-external-api-properties override-application.properties
Zelle Services API <ftm-instance>-zelle-services-api-properties override-application.properties
Any customizations to the Liberty server.xml configuration file can be done by adding XML snippets to the config-dropins.xml file in the ConfigMap for the component. The following list shows the ConfigMap names for the components that use WebSphere® Liberty.
  • <ftm-instance>-amount-keying-engine-dropins
  • <ftm-instance>-approvals-engine-dropins
  • <ftm-instance>-auto-adjust-engine-dropins
  • <ftm-instance>-business-rules-engine-dropins
  • <ftm-instance>-control-center-frame-dropins
  • <ftm-instance>-distribution-engine-dropins
  • <ftm-instance>-dup-detect-engine-dropins
  • <ftm-instance>-gateway-engine-dropins
  • <ftm-instance>-image-review-engine-dropins
  • <ftm-instance>-metering-dropins
  • <ftm-instance>-oac-dropins
  • <ftm-instance>-payment-repair-engine-dropins
  • <ftm-instance>-services-engine-dropins
  • <ftm-instance>-settlement-engine-dropins
  • <ftm-instance>-tcr-engine-dropins
  • <ftm-instance>-web-services-dropins
  • <ftm-instance>-web-services-business-rules-dropins
  • <ftm-instance>-web-services-gateway-dropins
  • <ftm-instance>-ws-common-services-pfs-dropins
  • <ftm-instance>-risk-engine-dropins
  • <ftm-instance>-noc-engine-dropins
  • <ftm-instance>-zelle-dropins
The JVM options can be customized by updating the jvm.options file in the ConfigMap for the component. The following list shows the ConfigMap names for the components that you can change the Java™ options for.
  • <ftm-instance>-amount-keying-engine-jvm-options
  • <ftm-instance>-approvals-engine-jvm-options
  • <ftm-instance>-auto-adjust-engine-jvm-options
  • <ftm-instance>-business-rules-engine-jvm-options
  • <ftm-instance>-control-center-frame-jvm-options
  • <ftm-instance>-distribution-engine-jvm-options
  • <ftm-instance>-dup-detect-engine-jvm-options
  • <ftm-instance>-gateway-engine-jvm-options
  • <ftm-instance>-image-review-engine-jvm-options
  • <ftm-instance>-metering-jvm-options
  • <ftm-instance>-oac-jvm-options
  • <ftm-instance>-payment-repair-engine-jvm-options
  • <ftm-instance>-services-engine-jvm-options
  • <ftm-instance>-settlement-engine-jvm-options
  • <ftm-instance>-tcr-engine-jvm-options
  • <ftm-instance>-web-services-jvm-options
  • <ftm-instance>-web-services-business-rules-jvm-options
  • <ftm-instance>-web-services-gateway-jvm-options
  • <ftm-instance>-web-services-pfs-jvm-options
  • <ftm-instance>-risk-engine-jvm-options
  • <ftm-instance>-noc-engine-jvm-options
  • <ftm-instance>-zelle-jvm-options
Notes:
  • The jvm.options file in the ConfigMaps has the default IBM® settings that must not be modified.
  • You can use only the ConfigMaps with names that are described in these tables and lists to customize the configuration files. ConfigMaps that have different names are not supported.
  • ConfigMaps must not be deleted and re-created manually to update any configurations in it. Manual recreation of the ConfigMaps can move them out of control of the operator. Therefore, only the existing resources must be updated with the new values.
  • You can create your ConfigMaps before you deploy your FTM offering. These ConfigMaps need the formation/update: disabled annotation in the annotations section of their spec.metadata.

Update the ConfigMap files

Complete the following steps to update the ConfigMap.
  1. Run the following command to download the config-dropins.xml file locally to the client computer.
    oc extract configmap/ftm-componentname-dropins --confirm
  2. Using an XML editor update the config-dropins.xml file.
  3. Run the following command to replace the existing ConfigMap file. 
    oc create cm ftm-componentname-dropins --from-file config-dropins.xml --dry-run=client -o yaml --save-config=true | oc apply -f -
    When oc apply is run for the first time on a ConfigMap, a warning occurs. The warning indicates that an annotation that oc apply requires is missing, but it is patched automatically. You can ignore the warning message.