Versions Compared

Old Version 48

changes.mady.by.user Former user

Saved on

compared with

New Version 49

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Content Zone
locationtop
Note

The Summarisation feature in Data Reporting is supported only for MSSQL database servers.

Configuring Open Banking Key Manager

Open the <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml file and add the following configurations below the </Analytics> tag. 

  • Replace the <WSO2_OB_BI_HOST> placeholder with the hostname of your WSO2 Open Banking Business Intelligence (WSO2 OB BI) server and configure other parameters accordingly. 
  • To publish the statistics set the value of the <Enabled> tag to true.
Code Block
languagexml
<BIServer>
	<MIReporting>
		<Enabled>true</Enabled>
		<ServerURL>{tcp://<WSO2_OB_BI_HOST>:7616}</ServerURL>
		<Username>admin</Username>
		<Password>admin</Password>
	</MIReporting>
</BIServer>

Configuring Open Banking API Manager

Configuring open-banking.xml

Open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file and add the following configurations below the </Analytics> tag. 

  • Replace the <WSO2_OB_BI_HOST> placeholder with the hostname of your WSO2 Open Banking Business Intelligence (WSO2 OB BI) server and configure other parameters accordingly. 
  • To publish the statistics set the value of the <Enabled> tag to true.
Code Block
languagexml
<BIServer>
	<MIReporting>
		<Enabled>true</Enabled>
		<ServerURL>{tcp://<WSO2_OB_BI_HOST>:7616}</ServerURL>
		<Username>admin</Username>
		<Password>admin</Password>
	</MIReporting>
</BIServer>
Configuring handlers

Open the <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml file and do the following:

  1. Add the APIInvocationLatencyStats handler just after the <handlers xmlns="http://ws.apache.org/ns/synapse"> tag.

    Code Block
    languagexml
    <handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.APIInvocationLatencyStatsHandler"/>

  2. Add the APIInvocationDataPublisher handler as the last ob-specific handler, right before the ## end of ob-specific handlers before the APIManagerExtensionHandler line. 

    Code Block
    <handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.APIInvocationDataPublisher" />

## end of ob-specific handlers before the APIManagerExtensionHandler
Note

Republish all the APIs for the above changes to take effect.

Multiexcerpt
MultiExcerptNameInvocationFailure
Capturing data during invocation failure scenarios

This is available only as a WUM update and is effective from December 20, 2019 (12-20-2019). For more information on updating WSO2 Open Banking, see  Updating WSO2 Products .

  1. Go to the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences directory.

  2. Create an XML file named api_invocation_fail_data_publisher.xml with the following content: 

    xml

  3. Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_throttle_out_handler_.xml file and add the  OBErrorDataPublisher  class under the sequence tag. 

  4. Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_auth_failure_handler_.xml file and add the the OBErrorDataPublisher class below the sequence key key element as shown below: 

    xml

    Also, add the OBErrorDataPublisher class after the AuthFailureResponseCreationMediator class as follows:

    If you can't locate the AuthFailureResponseCreationMediator class in the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/

    _auth_failure_handler_.xml file, please see .

Configuring Open Banking Business Intelligence

Configuring databases

Create the following databases in your database server to store raw and summarized data.

  • openbank_ob_reporting_statsdb
  • openbank_ob_reporting_summarizeddb
Configuring datasources

Update the <WSO2_OB_BI_HOME>/conf/worker/deployment.yaml file by adding the datasource configurations for OB_REPORTING_DB and OB_REPORTING_SUMMARIZED_DB. 

  • Update the jdbcUrl, username, password and driverClassName in the datasource entry with your database configurations.
  • Add the configurations after the TRA_DB datasource configurations.
    A sample configuration is given below:
Code Block
languagexml
- name: OB_REPORTING_DB
    description: The datasource used to store statistics for OB MI module
    jndiConfig:
      name: jdbc/OB_REPORTING_DB
    definition:
      type: RDBMS
      configuration:
        jdbcUrl: 'jdbc:sqlserver://192.168.108.23:1433;databaseName=openbank_ob_reporting_statsdb'
        username: 'root'
        password: 'root'
        driverClassName: 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
        maxPoolSize: 20
        idleTimeout: 60000
        connectionTestQuery: SELECT 1
        validationTimeout: 30000
        isAutoCommit: false

  - name: OB_REPORTING_SUMMARIZED_DB
    description: The datasource used to store summarized data for OB MI module
    jndiConfig:
      name: jdbc/OB_REPORTING_SUMMARIZED_DB
    definition:
      type: RDBMS
      configuration:
        jdbcUrl: 'jdbc:sqlserver://192.168.108.23:1433;databaseName=openbank_ob_reporting_summarizeddb'
        username: 'root'
        password: 'root'
        driverClassName: 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
        maxPoolSize: 20
        idleTimeout: 60000
        connectionTestQuery: SELECT 1
        validationTimeout: 30000
        isAutoCommit: false
Adding summarization script
  1. Download the OB_REPORT_SUMMERIZATION_MSSQl.siddhi script from here.
  2. Place the script in the <WSO2_OB_BI_HOME>/deployment/siddhi-files directory.

Restart the WSO2 Open Banking Business Intelligence, Key Manager and API Manager servers in the mentioned order, for the changes to take place.