Page Comparison

{noprint}
{float:right\|width=300px\|background=lightgrey\|border=solid blue 2px\|margin=10px\|padding=8px}*Contents*

{toc:all=true|depth=4|excerpt=true|indent=14px}
{float}\\  {noprint}
*Document Logs* *Change log:*
|| *Date:* || *Author:* || *Version:* || *Changes:* || Completed || Ext. || Int. || Is in Core ||
| {page-info:created-date\|dateFormat=dd MMMM yyyy}\\ | {page-info:created-user}\\ | 1.0 | Doc. created | Yes | | | |
*Terms and Definitions:*
|| {color:#003366}{*}Terms/definitions:*{color} || {color:#003366}{*}Meaning:*{color} ||
| TBD | To be defined |
| N/A | Not applicable |
\\
----

h1. IntroductionOverview

This document describes the interfacing between the Rator Customer Care and Billing System (Rator) and the Buckaroo BPE 3.0 payment systems . ThisThere interfaceare istwo fileengines based and will be discussed in detail in this document.

h2. Overview

This document describes the interfacing between the Rator Customer Care and Billing System (Rator) and the Buckaroo BPE 3.0 payment systems . There are two engines involved: Buckaroo Request Generator Engine and Buckaroo Payment Capture Engine. The Request Generator is responsible for generating the payment involved: Buckaroo Request Generator Engine and Buckaroo Payment Capture Engine. The Request Generator is responsible for generating the payment request csv file that will be sent to Buckaroo. The Capture engine is responsible for processing the payment response files received from Buckaroo. 

The Request Generator Engine collects all the Buckaroo Direct Debit Account Payments which are ready for capture in the system and inserts required payment information in buckaroo payment request tables. The engine handles the Account payments one by to create entries in these tables. These records are then processed by a File Processor engine instance which creates the payment request csv file to be sent to Buckaroo. 

{color:#ff0000}{*}Important Note{*}{color}: The Request Generator engine will only load the necessary payment data into DB tables. The file generation is not taken care of by this engine. The File Processor engine is responsible for creating the payment csv file using the data loaded into these tables. So the payment request file creation is a two step process and must be done as below:
# First run the Buckaroo Request Generator engine.
# Then run the File Processor Generator engine instance. The file processor engine will create a file only if the request engine processed the data successfully without any problems and the DB tables contain some records ready to be processed.

h2. Document usage

This document is primarily intended for the Rator implementation team and for confirming understanding of the interface with Buckaroo. It will also be used as a basis for acceptance tests.

*Note:* Please note that we have a separate integration with Buckaroo BPE 2.0 payment interface. This is also file based. For more detailed description of more information on Request Generator engine for integration towards thewith Buckaroo BPE 2.0 interface, please look [here|Integration:Buckaroo].

{color:#003366}{*}ScopeProduction Date{*}{color}

The scope of this document is the interface between the Buckaroo BPE 3.0 and Rator.

h2. Production Date

XX November 2013.

h2. Customer Configuration

The Buckaroo request generator engine is configurable by editing the engine configuration file.

<base_path>/engines/BuckarooRequestGeneratorBPE3/conf/engine.conf

The files can be edited in a normal text editor, like Windows Notepad.

h3. Engine Specific Properties

Some properties in the configuration file are specifically for engines, and are shown in the format below:
|| {color:#003366}{*}wrapper.java.mainclass{*}{color} || {color:#003366}{*}com.CDRator.billing.engine.GenericEngineStarter{*}{color} ||
| | This property specifies the Java path for CDRator engine starter. Main class property must be specified in order to start the engine framework. |
| | |
|| {color:#003366}{*}wrapper.app.parameter.1{*}{color} || {color:#003366}*\-S{*}{color} ||
| | The \-S property is optional, but it is a parameter for the GenericEngineStarter which enables the engine starter to make a sleep just before it stops. The reason for this is that in cases where the engine has nothing to do, it can complete very quickly. The Windows NT Service environment might see this as a possible failure and will do a failure count. When the count reaches a specific number, it will halt completely and the service has to be restarted manually. |
| | |
|| {color:#003366}{*}wrapper.app.parameter.2{*}{color} || {color:#003366}{*}300{*}{color} ||
| | Number of seconds engine starter must sleep before it stops. |
| | |
|| {color:#003366}{*}wrapper.app.parameter.3{*}{color} || {color:#003366}*\-P{*}{color} ||
| | Specifies that the next parameter is to start the engine. |
| | |
|| {color:#003366}{*}wrapper.app.parameter.4{*}{color} || {color:#003366}{*}com.CDRator.billing.paymentInterface.engine.BuckarooBPE3RequestGenerator.java{*}{color} ||
| | Specifies the java path of the engine class that the generic engine starter must use to start the engine |
| | |
|| {color:#003366}{*}wrapper.app.parameter.5{*}{color}\\  {color:#003366}*(customer-assigned number)*{color} || {color:#003366}{*}Additional command line arguments for the above-named Java class.*{color} ||
| | Parameter to engine. Specifies the engine name and how it will appear in logs and process monitor. This configuration parameter will make it possible to set a different engine name per brand, if multibrand setup is used.&nbsp; \\
\\
Used in the call to the Process Monitor together with the Instance Number. \\
\\
Examples: &nbsp;BuckarooBPE3RequestGenerator \\
\\ |
|| {color:#003366}{*}wrapper.app.parameter.6{*}{color}\\  {color:#003366}*(customer-assigned number)*{color} || {color:#003366}{*}Additional command line arguments for the above-named Java class.*{color} ||
| | Parameter to engine. Specifies engine's instance number.&nbsp;&nbsp; \\ |
|| {color:#003366}{*}wrapper.app.parameter.7{*}{color}\\  {color:#003366}*(customer-assigned number)*{color} || {color:#003366}{*}Additional command line arguments for the above-named Java class.*{color} ||
| | Parameter to engine. Specifies the max number of payments that the engine can handle in each run.&nbsp; \\ |

h1. Parameters required

The following parameter entries are used to specify the request generator configuration.


|| PATH || Type || description || Mandatory || Default value used if the parameter is not present ||
| INTEGRATION.BUCKAROO.BPE3.WEBSITE_KEY | String | Fixed string from Buckaroo portal \\ | YES | |
| INTEGRATION.BUCKAROO.BPE3.ACCOUNT_PAYMENT_TYPES \\ | String \\ | payment_type_id value of the \\
account_payment entries used&nbsp;to choose&nbsp; \\
what type of&nbsp;account&nbsp;payments are&nbsp; \\
picked up by the request \\
generator&nbsp;engine for&nbsp;creating the&nbsp; \\
payment export file. \\ | YES | |
| INTEGRATION.BUCKAROO.BPE3.DESCRIPTION_PREFIX | String \\ | Prefix for the description field \\ | YES | |
| INTEGRATION.BUCKAROO.BPE3.VAT_VALUE \\ | String \\ | VAT value \\ | YES | |
| INTEGRATION.BUCKAROO.BPE3.CURRENCY | String \\ | Currency Code | YES | |
| INTEGRATION.BUCKAROO.BPE3.DUE_DATE_OFFSET \\ | String \\ | Payment due date offset \\ | YES | |
| INTEGRATION.BUCKAROO.BPE3.EXPORT_FILE_PREFIX | String \\ | Prefix with which export file name \\
will start with \\ | YES | |
| INTEGRATION.BUCKAROO.BPE3.EXPORT_FILE_EXTENSION | String \\ | Extension used for export file. \\
For ex: .CSV | YES | |
| INTEGRATION.BUCKAROO.BPE3.CULTURE_CODE | String \\ | ISO culture code | NO | _nl-NL_ |
| INTEGRATION.BUCKAROO.BPE3.PAYMENT_METHODS_ALLOWED | String \\ | Allowed payment methods | NO | _machtiging,ideal_ \\ |
| INTEGRATION.BUCKAROO.BPE3.PAYMENT_METHOD_INVALID_BANK_ACC \\ | String | Allowed payment method if the bank account number is null or zero | NO | _ideal_ |
| INTEGRATION.BUCKAROO.BPE3.COUNTRY \\ | String \\ | Country code value | NO \\ | _NL_ |

h2. Database Tables

Following DB tables are used by the Buckaroo BPE3 Request Generator for saving the payment request information.&nbsp;

|| {color:#003366}{*}Name:*{color} | BUCKAROO_REQUEST_HEADER_BPE3 \\ ||
|| {color:#003366}{*}Description:*{color} | Each record represents a header which holds reference to the record data needed to generate a payment request file. Each header entry can have one or more corresponding request records in BUCKAROO_REQUEST_RECORD_BPE3 table. So for each record (not in ERROR status) in this table, there will be a payment file generated and sent to the Buckaroo. Contains the information like name of the file, status, file generation date, number of records in the file etc. ||
| | |
|| {color:#003366}{*}Name:*{color} | BUCKAROO_REQUEST_RECORD_BPE3 \\ ||
|| {color:#003366}{*}Description:*{color} | Each record represents a a payment record in the payment request file. Each record in this table contains actual payment information like amount, VAT, user info like name, bank account info, address etc. ||

{table-plus}

{table-plus}