Swann Insurance
Swann insurance interface and policies
Swann Interface
Swan Interface Process
The Swann Interface is used to send proposals for insurance policies to Swann Insurance's SIS system, and to retrieve the policy documents from Swann once the proposals have been processed. Contract events are used to track each stage of the process.
This interface replaces Swann's online Activ8 system.
Here are the three stages from the view point of a single policy, using the "Tyre and Rim" product as an example:
- Allocate Proposal Numbers: When you "Accept" a Quote containing Tyre and Rim Insurance to create an ORDER (contract), a contract event is created containing an allocated proposal number.
- Send Proposals: A scheduled service then sends a proposal document to the SIS system using the allocated proposal number, and creates a second contract event as a record.
- Receive Policies: Another scheduled service retrieves the policy document from the SIS system when available. It also creates a third contract event containing the Policy Number, and the policy document (PDF) as an attachment.
Illustration of Swann Events and Interface for a Tyre and Rim policy
Allocate Proposal Numbers
Swann Insurance will provide you with a predefined range of proposal numbers per product. Catch-e will store these numbers in during set-up.
A proposal number is allocated for each insurance product contained in the accepted quote. These are stored in Contract Events when you "Accept" a quote. The event code SWANTRPN is used for Tyre and Rim Insurance and SWANEWPN is for Extended Warranty Insurance. You'll see these listed in the "Type" filter on the Contract / Events screen.
Catch-e Support will be alerted when there are only 200 proposal numbers left!
Send Proposals
The scheduler runs a daily (typically) service called exportProposals). This service builds a list of contracts that have Tyre and Rim proposals ready to be sent to Swann based on the following criteria:
- A Contract Event exists for SWANTRPN (proposal number allocated).
- A Contract Event does not exist for SWANTRPS (proposal sent).
- A Reg No, Finance Start date, and VIN number have been assigned to the Contract.
A proposal document is created for the first Contract in the list. If the proposal document passes Swann's validation rules, it is sent to Swann Insurance's SIS system, and a Contract Event (SWANTRPS) is created.
If the proposal document fails any of the checks (usually because of missing data), the proposal document is not sent, and an error is added to the exceptions report. At the end of processing, the exceptions report is sent as a CSV attachment to the recipients in the Schedule Job. A typical entry looks like this:
Contract ID, Proposal Number, Data Source, Field, Error100255, 19883793, driver, salutation, is emptyIn this case the salutation field for the driver belonging to this contract (100255) has not been set. See the validation rules on the Tyre and Rim page.
The remainder of the contracts in the list are processed in the same way.
Warning: Swann process these proposals at 4:15pm every day so you should set the time for this scheduled service accordingly. The default is 3:30pm.
Receive Policies
The scheduler runs a service once a day (typically) called importPolicies). This service gets any new policy documents that have been issued by SIS. For each policy document it creates a Contact Event with an event code of SWANTRPR. The Contract Event stores the policy number and the policy document (PDF) as an attachment.
It locates each associated Contract by searching the Contract Events for the proposal number. The proposal number is supplied with the policy document. If no matching Contract can be found, an entry is made in an exception report. This exception report is emailed as a CSV attachment to the recipients in the Schedule Job.
The exception report looks like this:
Contract ID, Proposal Number, Error,19883793,missing contract eventWhen the error "SWAN_PS contract even has not been created" appears on the exception report, the following steps must be followed:
Go to the contract id in Catch-e specifically created to solve this issue. If this is the first time the error has appeared, then a 'dummy' contract must be created in Catch-e, as per normal Setting up a new Contract guidelines. Select an easily referenced registration number that can be remembered by all internal users.
Create a new Contract Event, dependant on the insurance product, as follows;
- SWANEWPN - Swann Extended Warranty Proposal Number
- SWANTRPN - Swann Tyre & Rim Proposal Number
- SWANWAPN - Swann Walkaway Proposal Number
Under the section titled "Proposal Number" enter the Proposal Number of the error record to be fixed.
- When the importPolicies) process runs again, the above process will have assisted in two things.
The error message will no longer appear on the exception report
A Policy Received (PR) Event will have been created against the 'dummy' contract.
Reference the Contracts / Events Tab of the 'dummy' contract
Find the relevant Policy Received (PR) Event and open the attached Policy Document
This then allows you to;
- See the Registration Number in the Policy Document
- Reference that Registration Number to it's true Contract in Catch-e and create the PR event in Contracts / Events, with the relevant Policy Document attached.
Warning: Swann issue these policies at 5:15pm every day so you should set the time for this scheduled service accordingly. The default is 7:00pm.
Swann Extended Warranty
Set-up
If the Swann Interface is active, the field "NVIC Code" (found in the Contracts / Vehicle screen) must be populated for Swann's SIS system to recognise vehicles where the Extended Warranty product is incorporated.
"NVIC Code" can be populated automatically by mapping the vehicle's Red Book code to a corresponding NVIC code using the table fmswannvehicles. For the mapping to be sucessful, the Quote's Warranty category also needs to match the field swannwtyctgrycode. If more than one record matches the quote, then the first record found is applied.
This matching process occurs automatically when a quote is Accepted. If no match occured when the quote was Accepted, or has subsequently become un-matched*, then in Contracts / Vehicle, the field "NVIC Code" is editable and has a lookup icon.
** The code contained in "NVIC Code" could become un-matched if the Warranty Category or Vehicle in the Quote is changed after the vehicle has been Accepted.*
The lookup is referred to as "Swann Vehicle Selector (NVIC)" in the tooltip and contains the fields "Make", "Model", "Model Year" and "Variant" to enable you to select the appropriate vehicle. All records with matching codes will be displayed, but only codes with a matching Category can be selected. Click on "Select" to apply the appropriate NVIC code.
Before a "SWANEWPN" Event is created (which assigns a policy number and sends the relevant data to Swann's SIS system), a validation routine re-checks the vehicle's NVIC Code match to ensure it is still a match. If it is no longer a match or a better match exists, the details are recorded in a validation report and no "SWANEWPN" event is created.
Global Controls
The following Global Controls should be populated:
Posting Classes
The following Posting Classes should be populated (these will appear as Contract Events) :
Tables
The table needs to be populated during set-up (see scheduled job Fm::swann::importVehicles) to enable the "NVIC Code" field to lookup Swann Insurance vehicle data (required for the Exended Warranty product).
The field swanninterfaceflag in the table needs to be set to 'yes' for Swann products.
Swann Interface Tyre And Rim
The Swann Interface is a legacy product that is no longer offered by Swan Insurance.
Go to Tyre and Rim Insurance for the current product information.
Global Controls
The following Global Controls should be populated:
qttyreriminsuranceplans
Tyre and Rim policy pricing is held in the table qttyreriminsuranceplans. This needs to be populated for quote calculations to work. Otherwise, the pricing comes from the Global Control qt tyreriminsurance.
The Swann Tyre & Rim interface may be turned on or off by updating the 'swanninterfaceflag' in qttyreriminsuranceplans (yes or no).
Posting Classes
The following Posting Classes should be populated (these will appear as Contract Events) :
Proposal Validation Checks
The following fields must be non-blank:
Swann Walkaway
Walkaway is a Swann Insurance product that can be set-up for inclusion as a quoting product extension.
The Swann Interface is a legacy product that is no longer offered by Swan Insurance.
Walkaway can be used without the Swann settings.
It is hidden by default, but can be enabled by updating * inclusionswalkawayflag* to 'yes'.
When a quote is accepted, a proposal event is created.
This event is used to trigger scheduled services to and from Swann Insurance to manage the set-up of the walkaway cover (detailed in Swann Interface). See below for the codes that are used.
The walkaway category and value is available in the settlement template.
Profile
If enabled, the fields below are shown on the Quotes / Lease tab.
Walkaway Set-up
The "Walkaway" field in Quotes/Finance is always visible, but for it to be available in the Quotes/Lease screen, the Global Controls field qt.inclusionswalkawayflag must be set to "yes". Only quotes done on or after the effective_from date will display the Walkaway product in Lease Inclusions.
Global Controls
The following Global Controls should be populated to enable this product.
Posting Classes
Tables
Walkaway Insurance is stored in it's own table: qtwalkawayplans. Each plan needs to be set-up here and flagged as "active".
Note: The table qtwalkawayplans contains a status_flag which is not presently used.
Decommissioning
If you don't want to use "Walkaway Insurance" anymore, set * inclusionswalkawayflag* to 'no'.
Once set, the row "Walkaway Insurance" will no longer display in the Quotes / Lease tab unless it was included prior to decommissioning.
In this scenario, if a quote is edited the "Walkaway Insurance" will remain included in the quote unless the user unchecks the product. This will remove "Walkaway Insurance" and recalculate the quote.
The "Walkaway Insurance" flag can not be re-selected once it has been unchecked (and * inclusionswalkawayflag* remains as 'no').