Bank Interfaces (BOQ, NAB, St George): St George Setup

Banking integrations for finance applications

St George Setup

Warning: This interface has been decommissioned and is no longer available in Catch-e. Go to the St George Interface NBI2 page for the current active interface details.

This page summarises the various flags and tables within Catch-e that need to be setup and populated with data to enable the St George Interface. Contact your Account Manager for assistance with your St George Interface setup and implementation plan.

Supplier record(s)

You need to create at least one Supplier record for St George. Set the Interface Type on the Suppliers Account page to 'st_george'.

Global Controls

ModuleNameCommentValue
St George HTTP Basic Authentication credentials
qtstgeorgeloginSt George HTTP Basic Authentication credentials.Fields ‘host' , 'user' and 'password' must be populated. Values are encrypted, contact Catch-E for set up
Street/Postal Addresses
St George requires Street and Postal address of each applicant. The system allows the option of specifying which address to be used for this purpose. The Source of Street and Postal addresses to be used can be controlled by 3 following controls in gb_controls.
qtstgeorgeaddresssourceoperatingDetermines which address should be used to populate street address (address sequence # 1 in XML) for Operating/Finance Lease application for company. • gbcompanies = Lookup details from gbcompanies where ‘default flag’ = ‘yes’ Following fields in gbcompanies need to be populated address1, address2 (optional), city, state, postcode, phone, emailfinance • fmclients = Lookup from fmclients's:12:"gbcompanies";' OR 's:10:"fmclients";'
qtstgeorgepostaladdresssource_operatingDetermines which address should be used to populate Postal address (address sequence # 2 in XML) for Operating/Finance Lease application for company. • gbcompanies = Lookup details from gbcompanies where ‘default flag’ = ‘yes’ Following fields in gbcompanies need to be populated postaladdress1, postaladdress2 (optional), postalcity, postalstate, postalpostcode • fmclients = Lookup from fmclients's:12:"gbcompanies";' OR 's:10:"fmclients";'
qtstgeorgepostaladdresssource_novatedDetermines which address should be used to populate Postal address (address sequence # 2) for Finance lease application for individual. Note that street address (address sequence # 1) is always driver’s residential address. • gbcompanies = Lookup details from gbcompanies where ‘default flag’ = ‘yes’ Following fields in gbcompanies need to be populated companyname, postaladdress1, postaladdress2 (optional), postalcity, postalstate, postalpostcode • fmclients = Lookup from fmclients • fmdrivers = Lookup from fm_drivers's:12:"gbcompanies";' OR 's:10:"fmclients";' OR 's:10:"fm_drivers";'
qtstgeorgerun_dateSystem Run date in Sovereign System. Used as effective date in St George Finance application for data items that don't have an associated effective date in Ctach-E e.g Phone or Fax noIn Live = blank ("") for Today's date In Test a Mysql date e.g s:10:"2009-02-16";

Contract Type to St George Product Type Mapping

Warning: The Interface will not be available if this mapping has not been set up for the Contract Type/Term and Effective Date combination in use. This means the ‘Apply’ button will not appear.

FieldDescriptionAllowed Value
qtfinancierpostingmapdefaults
producttypecodeSt George Product TypeFLE = Finance Lease OLE = Operating Lease
xml_templateType of St George XML Template to useindividual company
financeapplyfrom_typeWhere the ‘Apply’ button is availableqtquotes = Quote / Finance Page fmcontracts = Contract/Finance Page any = Both Quote and Contract Finance pages
effective_dateEffective Date of this mapping<= qtquotes.date when financeapplyfromtype = qtquotes <= TODAY when financeapplyfromtype = fm_contracts

Example of mapping Contract Type to St George Product Type

Contract TypeSt George Customer TypeSt George Application TypeAvailable in Catch-E
NOFBIndividualFinance LeaseQuotes/Finance page
FMCompanyOperating LeaseContracts/Finance page
FINCompanyFinance LeaseContracts/Finance page

Originator and Sovereign Client Code

These codes are used by St George Sovereign system to identify and classify an application. These codes are set by St George.

gbstgeorge_originators

  • originator_code — 10 character Originator Code Each client to get the list from St George. Example 0020009999
  • user_code — 10 character Sovereign Client Code. The user code could be same for all Originators or different one for each originator. Used as user in XML HEADER section. Sovereign documentation defines this as The user in the header segment represents the user 'enrolled' to SOA. Suggest this might represent the external Finance Company and should be configured as a Sovereign Client. Enrolment provides some 'application' level security. As Above. Example 0010002111
  • description — Originator Description Originator name
  • status_flag — Active or Inactive active or inactive

Sovereign User ID mapping for Catch-e users

Warning: ''The interface will not be available if this mapping has not been set up for the logged in user. This means the ‘Apply’ button will not be available.

FieldDescriptionAllowed Value
gbuserlogins
user_idLinking to Catch-e user id in gb_usersExample 10006
serviceService for which this login to be usedst_george
login10 character Sovereign User CodeEach client to get the list of valid users from St George. Example 0020009999
status_flagActive or Inactiveactive or inactive

Useful Queries

SELECT * FROM fm_suppliers WHERE interface_type = 'st_george';SELECT * FROM gb_controls WHERE name LIKE '%st_george%';SELECT t2.supplier_code AS 'Financier', t3.posting_map_code AS 'Contract Type', t1.term, t1.product_type_code,t1.xml_template, t1.finance_apply_from_type, t1.effective_dateFROM qt_financier_posting_map_defaults AS t1INNER JOIN fm_suppliers AS t2 ON t2.supplier_id = t1.supplier_idINNER JOIN gl_posting_maps AS t3 ON t3.posting_map_id = t1.posting_map_idWHERE t2.supplier_code = 'STG';SELECT * FROM gb_st_george_originators;SELECT * FROM gb_user_logins WHERE service = 'st_george';

St George NBI2 Setup

Warning: This interface has been decommissioned and is no longer available in Catch-e.

This page summarises the setup requirements to enable the St George NBI2 Interface. Contact your Account Manager for assistance with your St George Interface setup and implementation plan.

Note: The NBI2 interface replaces the first generation of St George's interface to Sovereign. Click here to read about it.

Client set-up steps

You need the following details from St George. They need to be sent to your Catch-e Account Manager.

  1. Originator code (you can have more than one)
  2. Client app code
  3. User logins
  4. Testing endpoints (if testing the feature before using it in Live)

Supplier record

Create or update your St George supplier records. Set the Suppliers / Account "Interface Type" field to be 'stgeorgenbi2'.

Posting Class

Go to the Posting Classes / Details tab and check that the "Class Code" 'APPBD2' record has the "Event?" checkbox selected. This record will exist, but will be un-checked until you need to use it.

Financier Posting Map defaults

Add or check your entries in Setup / Reference Data → qt financier posting map defaults. You'll need an entry for each Contract Type you are quoting that will be using this feature.

Est / Admin Fee

The Quotes / Finance "Establishment / Admin Fee" field can be populated from a number of defaults in the system. Visit Establishment Fee for the full explanation of this.

However, the value that is populated into the Sovereign field "Establishment Fee" will come from the value you enter here in the "Est / Admin Fee" field.

If there is difference between the quotes "Establishment / Admin Fee" and the value stored here in "Est / Admin Fee", and it is positive, then the surplus will be added to the Brokerage calculation and sent to the Sovereign field "Brokerage".

For the entire value of "Establishment / Admin Fee" to be populated into the Sovereign field "Establishment Fee", check and keep both amounts the same.

Effective

Be aware that if you enter "Effective" date, this must be less than or equal to the Quotes / Contact "Effective Date", or the records will not be linked. If you are entering the first record of this kind, leave "Effective" blank to cover all existing quotes.

Global Controls

You should not need to update any of the controls which will work at their default settings.

Go to Setup / Reference Data → gb_controls to update these if required.

  • stgeorgeleaseinclusionbrokerage_flag — Lease Inclusions are mapped to the "Other Brokerage" field in Sovereign as the default configuration. To map this to "Other Insurance" instead, set this control to 'no'. yes
  • stgeorgenbi2applicationid — A system requirement for NBI2 interface V5-001
  • stgeorgenbi2clientapp_code — This code is prefixed to the external-system-reference parameter in the XML output that is generated for the application to Sovereign and it forms part of a unique identifier for each section of the XML. This defaults as CE, but can be updated if desired. Sovereign does not use this value. CE
  • stgeorgenbi2paymentmethod_code — This is set as 'BPAY' as standard. It can also be 'DD' by arrangement with St George. If the value is 'DD', the bank account number stored in in the 'Payables' section is returned in the xml also. Note: Effective Date on Global Control must be set to '0000-00-00'. BPAY
  • stgeorgenbi2rundate — System Run date in Sovereign System. Used as effective date in St George Finance application for data items that don't have an associated effective date in Catch-e e.g Phone or Fax no. In Live this is left blank, so that today's date is used. If you are connected to a Sovereign Test environment, this is set to a MySQL date to match their Test environment. E.g '2009-02-16'
  • stgeorgenbi2userid_source — Set which Catch-e user will be listed as the user making the application in Sovereign. Go to the Who is applying section for more details. standard
  • stgeorgenbi2wssesecurity_login — This contains encrypted values for "Host", "User Name" and "Password". These are pre-set for Catch-e and should not need to be updated. Encrypted value
  • stgeorgepostaladdresssourcenovatedDetermines which address should be used to populate Postal address (address sequence # 2) for Finance lease application for individual. Note that street address (address sequence # 1) is always driver’s residential address. You can choose from 'gbcompanies' or 'fmclients'. 'fmdrivers' does not work in this application. Type
  • gbcompanies — Lookup details where flag* = 'yes' The following fields in the selected record needs to be populated: companyname, postaladdress1, postaladdress2 (optional), postalcity, postalstate, postal_postcode.
  • fmclients — Lookup from fmclients

fm_drivers

  • stgeorgepostaladdresssourceoperating — Enter the address to use to populate the application's Postal address. You can choose from 'gbcompanies' or 'fmclients'. fmclients

Financier Posting Map defaults

In the background, set the following fields as they are not accessible via user screens;

FieldDescriptionAllowed Value
qtfinancierpostingmapdefaults
producttypecodeSt George Product TypeFLE
xml_templateType of St George XML Template to useindividual
financeapplyfrom_typeThis determines where the Apply button is availableqt_quotes

Originator codes

Enter the provided Originator codes here.

FieldDescriptionAllowed Value
gbstgeorge_originators
originator_code10 character Originator CodeE.g.0020009999
descriptionDisplays on the Quotes / Finance "Originator" listbox.Originator name
status_flagOnly active records will display in the Quotes / Finance and Contracts/ Finance "Originator" listbox.'active' or 'inactive'

User logins

Only users with a stored login record can access the application features. St George will provide these details. Enter them here.

FieldDescriptionAllowed Value
gbuserlogins
userloginidUnique system id
user_idLinking to Catch-e user id in gb_usersE.g. 10006
serviceService for which this login to be usedstgeorgenbi2
hostNot required for this service
login10 character Sovereign User CodeEach client to get the list of valid users from St George. Example 0020009999
passwordNot required for this service
status_flagSet this to 'active' for new users and 'inactive' if removing access.'active' or 'inactive'

Other tables

The following tables should also be checked and set-up;

  • fmclientindustries (there is a standard table set-up that needs to be upgraded to use St George data).
  • fmdriveremployment_types
  • fmdriveroccupation_codes

Who is applying

Each finance application is linked to a registered Sovereign user. The mapping table below shows how you can determine which Catch-e user record will be used to make the Sovereign application.

This can be updated in the record.

Global Control ValueSubmission LocationUser ID SourceNotes
standardQuotes Finance tab Contracts Finance tabuserid for the user that is logged into Catch-e. userid for the user that is logged into Catch-e.
account_managerQuotes Finance tab Contracts Finance tabA/C Manager - A/C Manager -Where Quotes A/C Manager is blank use Clients A/C Manager.
sales_managerQuotes Finance tab Contracts Finance tabSales Manager - Sales Manager -
assignedQuotes Finance tab Contracts Finance tabAssigned - useridassigned. Order Manager - ordermanageruser_id.Where either of these is blank use the user_id for user that’s logged into Catch-e.

Useful Queries

SELECT * FROM fm_suppliers WHERE interface_type = 'st_george_nbi2';SELECT * FROM gb_controls WHERE name IN('st_george_nbi2_wsse_security_login','st_george_postal_address_source_novated','st_george_postal_address_source_operating','st_george_nbi2_run_date','st_george_nbi2_application_id','st_george_nbi2_client_app_code','st_george_nbi2_payment_method_code','st_george_lease_inclusion_brokerage_flag');SELECT t2.supplier_code AS 'Financier',t2.interface_type,t3.posting_map_code AS 'Contract Type', t1.term, t1.product_type_code,t1.xml_template, t1.finance_apply_from_type, t1.establishment_fee, t1.establishment_fee_cost, t1.effective_dateFROM qt_financier_posting_map_defaults AS t1INNER JOIN fm_suppliers AS t2 ON t2.supplier_id = t1.supplier_idINNER JOIN gl_posting_maps AS t3 ON t3.posting_map_id = t1.posting_map_idWHERE t2.name LIKE '%St George%';SELECT * FROM gb_st_george_originators;SELECT t2.full_name, t1.* FROM gb_user_logins AS t1 INNER JOIN gb_users AS t2 ON t2.user_id = t1.user_id WHERE t1.service = 'st_george_nbi2';SELECT * FROM fm_client_industries;SELECT * FROM fm_driver_employment_types;SELECT * FROM fm_driver_occupation_codes;