Custom Letter Blocks - Insync Letter Premium Breakdowns

This explains how you can map premium breakdown values in ICE Policy to KCM to show on the Insync Letters that need generating per scheme.

There are several steps to this process, the first being as part of the Customer Letter Blocks, then standard field mapping into the Field Sets and then adding to your Text Block.

Step 1 - Customer Letter blocks

Navigate to Includes > Customer > Customer-LetterBlocks > Edit

You will then need to add/edit the code to cover the fields you'd like mapping.

The document is split into sections (procedures) and the first one you will need to amend is 'PROC selected_cover_setup' if your scheme has a legal expense add on(s) you want to map.

You should copy the below section and paste it at the end of the procedure before the FI. Then update the 'LEGALEXPENSESNURSE' to the name of your legal cover in Workbench, update "YES" to whatever you'd like to show on your doc if the add on is added, update "£100,000" to the sum insured amount you'd like to show on your doc and lastly update 'LEGALEXPENSESNURSE' before the _TechnicalGrossPre... to match the cover name in Workbench.

You will then need to do the same for the second half of the 'PROC selected_cover_setup' procedure that creates cover fields for excess protection, if your scheme has the excess protection add on(s).

Below is an example that you need to copy, paste before the FI and amend the 'AXISEXCESS1000', "YES", "£1,000", 'AXISEXCESS1000' as per the legal step.

Next you need to create a new procedure for your scheme to map the premium related fields. You should have a procedure per scheme. For this you can copy and paste an existing procedure eg 'PROC axis_field_setup' and update accordingly. See example:

When pasting I would paste it at the end of all of the scheme field setup procedures to keep the document tidy - you will note that the document currently goes PROC axis_field_setup, PROC beazley_field_setup, PROC faradaytradesman_field_setup, xxx, so add to the end.

You will need to update the procedure name in line 1 ie xxx_field_setup. You also need to update the cover names to match Workbench in lines 16 and 18 ie "AXISMEDICAL" and "AXISSTANDARD". Lastly you need to update the user fields names at the end of the procedure, these can be anything but make them meaningful. I would only ever update the scheme name element of the name ie the AXIS part of AXISPriceBaseInclTax to xxxPriceBaseInclTax

The final step is to add the procedure name you have created to the list of PROC custom_proc at the end of the document. Again I would keep the order of the list inline with the document to keep it easy to read.

Once all of the above has been done (as needed for the specific scheme) you need to save and close the file. There is no need to unlock at this stage, and Includes cannot be accepted or published.

Next, right click on the Wizard template and click on "Create Master Template". This will compile all of the code in the includes into a new version of the Wizard.

At this stage the wizard can be tested locally in KCM by right-clicking and selecting "Test". If you are unsure on how to test using the wizard, see 'Document Testing via Wizard instead of ICE Policy' guide. Once you have tested and are happy, you can unlock the wizard, this will also unlock any includes. To mark changes as accepted you must expand out the Wizard and accept the new version of the compiled code.

In the above screenshot 1.73 is my new version, which is accepted, and hence in use by UAT. 1.72 is the previous version, which is still in use by Live.

Step 2 - User Fields

Once you have finished with the Customer Letter Block, the next step is to add the user fields from the end of the procedure to the field set.

Navigate to Field Sets > ICEUserFields > Edit

As per the guide for 'Policy Level Field Mapping' you need to add the field names to the field set ie variations of xxxPriceBaseInclTax that you created. It is essential these match what you have set in your procedure.

Once all added, save and close, unlock, accept and then publish when tested.

Step 3 - Text blocks

Once the above two steps are complete, you can then add the field to your text block via the IPT/MDK Toolbox in the usual way.

Summary

As a brief summary of the code in Customer-Letterblocks, there are custom procedures defined with the PROC keyword, at the end of the file a procedure called custom_proc is defined. This custom_proc is called by the Wizard, and in turn calls our custom procedures. Any new procedures that need to run should be added here.

The language used here is Kofax's template scripting language, a guide to this can be found in the KCM designer by clicking Help > Template Scripting Guide.

Please be cautious about making changes in this area, always take a backup before starting and contact ICE Support Desk if you have any questions.

Full JIRA - https://jira.iceinsuretech.com/browse/INSYNC-429

Last updated