This documentation is for WSO2 Open Banking version 1.5.0. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

Follow the steps below to upgrade WSO2 Open Banking from 1.4.0 to 1.5.0.


Databases and Synapse configurations

  • Take a backup of the existing database used by WSO2 Open Banking 1.4.0. This backup is necessary in case the migration causes issues in the existing database.

  • Take a backup of the existing synapse configurations in WSO2 Open Banking 1.4.0. The synapse configuration is available in the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs directory.

Custom configurations

Copy the following content from WSO2 Open Banking 1.4.0 to WSO2 Open Banking 1.5.0: 

ContentCopy fromCopy to
Synapse configurations <WSO2_OB_APIM_140_HOME>/repository/deployment/server/synapse-configs <WSO2_OB_APIM_150_HOME>/repository/deployment/server/synapse-configs
Custom configurations<WSO2_OB_KM_140_HOME>/repository/conf <WSO2_OB_KM_150_HOME>/repository/conf
<WSO2_OB_APIM_140_HOME>/repository/conf<WSO2_OB_APIM_150_HOME>/repository/conf

Custom OSGI bundles

(manually added files)

<WSO2_OB_KM_140_HOME>/repository/components/dropins <WSO2_OB_KM_150_HOME>/repository/components/dropins
<WSO2_OB_APIM_140_HOME>/repository/components/dropins <WSO2_OB_APIM_150_HOME>/repository/components/dropins

Custom JAR files

(manually added files)

<WSO2_OB_KM_140_HOME>/repository/components/lib<WSO2_OB_KM_150_HOME>/repository/components/lib
<WSO2_OB_APIM_140_HOME>/repository/components/lib<WSO2_OB_APIM_150_HOME>/repository/components/lib



Application attribute changes

WSO2 Open Banking 1.5.0 supports both regulatory and non-regulatory APIs. To use this feature, you need to update the application attributes. Run the relevant migration script in the given locations against the openbank_apimgtdb database. 

DatabaseScript location
openbank_apimgtdb<WSO2_OB_KM_HOME>/dbscripts/finance/apimgt/migration-1.4.0_to_1.5.0




PSD2 Data Reporting 

If you are using WSO2 Open Banking Business Intelligence (WSO2 OB BI) for PSD2 Data Reporting, execute the relevant database script against the mentioned databases:

DatabaseScript location
openbank_ob_reporting_statsdb<WSO2_OB_BI_150_HOME>/resources/finance/dbscripts/migration-to-1.5.0/ob_stats_db
openbank_ob_reporting_summarizeddb<WSO2_OB_BI_150_HOME>/resources/finance/dbscripts/migration-to-1.5.0/ob_summarize_db



UK

  1. Run the relevant database script in the given locations against the openbank_openbankingdb database.

    DatabaseScript location
    openbank_openbankingdb<WSO2_OB_KM_HOME>/dbscripts/finance/openbanking.org.uk/migration-1.4.0_to_1.5.0/
    openbank_openbankingdb<WSO2_OB_KM_HOME>/dbscripts/finance/event-notification/migration-1.4.0_to_1.5.0/
  2. To disable validating and signing payload for x-jws-signature header, set the following configuration to false in the open-banking.xml files.

    • <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml
    • <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml
    <SigningConfiguration>
    	<Enable>false</Enable>
  3. Changes for Dynamic Client Registration:
    1. Add the following configurations for Dynamic Client Registration under <Server> tag and update them accordingly. Remove any DCR configurations within the <UK> tags.

      <DCR>
      	<TokenAuthentication>
      		<Method>private_key_jwt</Method>
      		<Method>tls_client_auth</Method>
      	</TokenAuthentication>
      	<ConnectionTimeout>0</ConnectionTimeout>
      	<ReadTimeout>0</ReadTimeout>
      	<EndPointURL>
      		<ServiceProviderCreation>/client-registration/v0.14/register</ServiceProviderCreation>
      		<Application>/api/am/store/v0.14/applications</Application>
      		<Token>/token</Token>
      		<KeyGeneration>/api/am/store/v0.14/applications/generate-keys</KeyGeneration>
      		<ApiSearch>/api/am/store/v0.14/apis</ApiSearch>
      		<ApiSubscribe>/api/am/store/v0.14/subscriptions/multiple</ApiSubscribe>
      	</EndPointURL>
      	<EnableURIValidation>false</EnableURIValidation>
      	<EnableHostNameValidation>false</EnableHostNameValidation>
      	<APISubscriptions>
      		<PISP>
      			<APIContext>/open-banking/v3.1/pisp</APIContext>
      			<APIContext>/open-banking/v3.0/pisp</APIContext>
      			<APIContext>/open-banking/v2.0/pisp</APIContext>
      		</PISP>
      		<AISP>
      			<APIContext>/open-banking/v3.1/aisp</APIContext>
      			<APIContext>/open-banking/v3.0/aisp</APIContext>
      			<APIContext>/open-banking/v2.0/aisp</APIContext>
      		</AISP>
      	</APISubscriptions>
      	<UseSoftwareIdAsApplicationName>true</UseSoftwareIdAsApplicationName>
      	<JwksUrlSandbox>https://keystore.openbankingtest.org.uk/keystore/openbanking.jwks</JwksUrlSandbox>
      	<JwksUrlProduction>https://keystore.openbanking.org.uk/keystore/openbanking.jwks</JwksUrlProduction>
      </DCR>

      <DCR>
      	<TokenAuthentication>
      		<Method>private_key_jwt</Method>
      		<Method>tls_client_auth</Method>
      	</TokenAuthentication>
      	<ConnectionTimeout>0</ConnectionTimeout>
      	<ReadTimeout>0</ReadTimeout>
      	<EnableURIValidation>false</EnableURIValidation>
      	<EnableHostNameValidation>false</EnableHostNameValidation>
      	<UseSoftwareIdAsApplicationName>true</UseSoftwareIdAsApplicationName>
      	<JwksUrlSandbox>https://keystore.openbankingtest.org.uk/keystore/openbanking.jwks</JwksUrlSandbox>
      	<JwksUrlProduction>https://keystore.openbanking.org.uk/keystore/openbanking.jwks</JwksUrlProduction>
      </DCR>

    2. Update the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/<USERNAME>--DynamicClientRegistrationAPI_vv3.2--In.xml file as follows:
      • Replace <header name="To" value="https://<WSO2_OB_APIM_HOST>:9443/ob-dynamic-client-registration"/> property with the new /dynamic-client-registration/common endpoint. 

        <header name="To" value="https://<WSO2_OB_APIM_HOST>:9443/dynamic-client-registration/common"/>
    3. Update the ApplicationDeletion executor value as follows. See Dynamic Client Registration v3.2 - Configuring application deletion workflow, for more information. 

      <ApplicationDeletion executor="com.wso2.finance.open.banking.application.deletion.workflow.impl.ApplicationDeletionWorkflow"/>
  4. Go to the API Publisher ( https://<WSO2_OB_APIM_HOST>:9443/publisher), add the following API properties to the already deployed APIs and republish them. For more information, see Deploying APIs for UK.
    API

    Property Name

    Property Value
    AccountInfo API v3.1.1ob-specuk
    ob-api-typeaccount
    ob-api-version3.1.1
    Payments API v3.1.1ob-specuk
    ob-api-typepayment
    ob-api-version3.1.1
    Funds Confirmation API v3.1.1ob-specuk
    ob-api-typecof
    ob-api-version3.1.1
    Event Notifications API v3.1.0ob-specuk
    ob-api-typeevent
    ob-api-version3.1.0
    Dynamic Client Registration API v3.2ob-specuk
    ob-api-typedcr
    ob-api-version3.2

Berlin (Upgrading from 1.3.0 to 1.3.3)

  • Go to the API Publisher ( https://<WSO2_OB_APIM_HOST>:9443/publisher), add the following API properties to the already deployed APIs and republish them. For more information, see Deploying APIs for Berlin
    Property NameProperty Value
    ob-specberlin
    ob-api-typepsd2

AU (Upgrading from v1.0.0 to v1.2.0)

  1. Run the relevant database script in the <WSO2_OB_KM_HOME>/dbscripts/finance/openbanking.org.uk/migration-1.4.0_to_1.5.0 directory against the openbank_openbankingdb database.

  2. Add the following configurations to the open-banking.xml files, under the <Server> tag. The open-banking.xml files are in below locations:

    • <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml

    • <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml

    These configurations are for:

        
    <AU>
    	<MetaDataCache>
    		<EnableMetaDataCache>true</EnableMetaDataCache>
    		<MetaDataCacheUpdatePeriod>5</MetaDataCacheUpdatePeriod>
    		<DefaultCacheTimeout>1</DefaultCacheTimeout>
    		<DataRecipientsDiscoveryURL>DR_DISCOVERY_MOCK_URL</DataRecipientsDiscoveryURL>
    		<SoftwareProductsDiscoveryURL>SP_DISCOVERY_MOCK_URL</SoftwareProductsDiscoveryURL>
    		<DCRInternalURL>https://
    			<WSO2_OB_APIM_HOST>:9443/dynamic-client-registration/common/register/
    			</DCRInternalURL>
    		</MetaDataCache>
    		<ResourcePaths>
                /banking/accounts,
                /banking/accounts/balances,
                /banking/accounts/direct-debits,
                /banking/accounts/{AccountId}/balance,
                /banking/accounts/{AccountId},
                /banking/accounts/{AccountId}/transactions,
                /banking/accounts/{AccountId}/transactions/{transactionId},
                /banking/accounts/{AccountId}/direct-debits,
                /banking/accounts/{AccountId}/payments/scheduled,
                /banking/payments/scheduled,
                /banking/payees,
                /banking/payees/{payeeId},
                /banking/products,
                /banking/products/{productId},
                /common/customer,
                /common/customer/detail,
                /discovery/status,
                /discovery/outages
            </ResourcePaths>
    		<HolderIdentifier>
    			<!--configure bank specific identifier-->
    		</HolderIdentifier>
    		<Enforcement>
    			<Cache>
    				<CacheEnabled>true</CacheEnabled>
    				<ModifiedExpiryMinutes>15</ModifiedExpiryMinutes>
    				<AccessedExpiryMinutes>15</AccessedExpiryMinutes>
    			</Cache>
    		</Enforcement>
    	</AU>
  3. Add the following configurations for Dynamic Client Registration under <Server> tag and update them accordingly. Remove any DCR configurations within the <UK> tags.

    <DCR>
    	<TokenAuthentication>
    		<Method>private_key_jwt</Method>
    		<Method>tls_client_auth</Method>
    	</TokenAuthentication>
    	<ConnectionTimeout>0</ConnectionTimeout>
    	<ReadTimeout>0</ReadTimeout>
    	<!--The endpoint urls are to access the rest APIs of API manager in order to
            create the application, service provider and generate keys for the application.
             -->
    	<EndPointURL>
    		<ServiceProviderCreation>/client-registration/v0.14/register</ServiceProviderCreation>
    		<Application>/api/am/store/v0.14/applications</Application>
    		<Token>/token</Token>
    		<KeyGeneration>/api/am/store/v0.14/applications/generate-keys</KeyGeneration>
    		<ApiSearch>/api/am/store/v0.14/apis</ApiSearch>
    		<ApiSubscribe>/api/am/store/v0.14/subscriptions/multiple</ApiSubscribe>
    	</EndPointURL>
    	<EnableURIValidation>false</EnableURIValidation>
    	<EnableHostNameValidation>false</EnableHostNameValidation>
    	<!-- Use SoftwareID in SSA as Application Name-->
    	<UseSoftwareIdAsApplicationName>false</UseSoftwareIdAsApplicationName>
    </DCR>
  4. Go to the API Publisher ( https://<WSO2_OB_APIM_HOST>:9443/publisher), add the following API properties to the already deployed APIs and republish them. For more information, see Deploying APIs for AU
    API

    Property Name

    Property Value
    Consumer Data Standards API v1.2.0

    ob-specau
    ob-api-typeaccount
    Consumer Data Standards Administration API v1.2.0

    N/AN/A
    Dynamic Client Registration API v0.1ob-specau
    ob-api-typedcr
  • No labels