Form Configuration (Files)

Configuration files are files that can augment / improve the control you have over the functionality in the form beyond the settings.

Configuration files are generally in XML format and so please ensure the XML file is still valid are you finish your edits. You can check an XML file is valid using the following:

https://www.samltool.com/prettyprint.php

For the HBAA - Full Case Review form, there are 2 and these files that are relevant and these are covered below:

evidencerules.xml

The purpose of this file is to enable one to control, which evidence is presented dynamically to the citizen when NO Risk Based Verification service is enabled. I.e. This is the default configuration file.

You don't need to ever change this file. It's just to explain you can if you want to.

Example file

Note - this file is bigger than this - we've taken an excerpt.

<Evidences>	
<Evidence resourceId="Rule_NewPensionOrAnnuity">
		<Text>
			<![CDATA[
			<p><b>Evidence of your pension or annuity</b></p>
			<p>Proof of State, Occupational, Personal or other pensions - monthly statements, annual P.60's etc, letters from Pension providers, and proof of date of increase.</p>
			]]>
		</Text>
		<Rules>
			<Rule>
				<XPath>eForm/page[@id='whathaschanged']/ChangeOfPension/item[@selected='True' and @value='Yes']</XPath>
				<Operator>Exists</Operator>
			</Rule>
		</Rules>
	</Evidence>
	<Evidence resourceId="Rule_NewPartnerIdentity">
		<Text>
			<![CDATA[
			<p><b>Evidence of your partner's identity</b></p>
			<p>We need to see 1 from UK Passport (current or expired), Photocard Driving Licence, UK residence permit, Alien's registration card, Certificate of employment in HM Forces, Concessionary bus pass with photo. OR 2 from Paper Driving Licence, Birth Certificate, Marriage Certificate, Divorce/annulment papers, Medical Card, Recent Bank statements, Recent paid bill, for example, gas, electric, water (not Council Tax), A letter that has been sent to them from a solicitor, Inland Revenue, doctor, social worker or probation officer.</p>
			]]>
		</Text>
		<Rules>
			<Rule>
				<XPath>eForm/page[@id='movedin']/PartnerMovedIn/item[@selected='True' and @value='Yes']</XPath>
				<Operator>Exists</Operator>
			</Rule>
		</Rules>
	</Evidence>
	<Evidence resourceId="Rule_NewPartnerNI">
		<Text>
			<![CDATA[
			<p><b>Evidence of your partner's national insurance number</b></p>
			<p>Such as P45, P60, wage/salary statement, tax letter, Department for Work and Pensions notification letter, National Insurance card, a benefit book (but not Child Benefit), for self-employed people a bank statement showing Class 2 national insurance payments paid by direct debit - providing it shows your partner's N.I. number. We need to see one of these documents.</p>
			]]>
		</Text>
		<Rules>
			<Rule>
				<XPath>eForm/page[@id='movedin']/PartnerMovedIn/item[@selected='True' and @value='Yes']</XPath>
				<Operator>Exists</Operator>
			</Rule>
		</Rules>
	</Evidence>
	</Evidences>	

Basically this file enables you to control when each of the different evidence paragraphs appear in the eChanges based upon the person's changes provided.

For example, there is an evidence resource called Rule_NewPartnerIdentity.

  <Evidence resourceId="Rule_NewPartnerIdentity">

And within that section there is a Rules section that outlines the rules that set whether evidence is requested or not:

<Rule>
<XPath>eForm/page[@id='movedin']/PartnerMovedIn/item[@selected='True' and @value='Yes']</XPath>
<Operator>Exists</Operator>
</Rule>

The rule above is saying if there if on the page PartnerMovedIn the person says Yes to one moving in, evidence of their identity will be requested.

livingsituation.xml

This is an important file in the context of eChanges. The contents of it control:

a) What appears in the list of living situations for the new address a person is moving to i.e. when the change reported is a change of address

b) The behaviour of the option selected

Example file

The file contains a section for each drop down option. The following shows the file with only the first drop down option populates for simplicity of understanding:

<LivingSituation>

  <!-- I own my home -->
  <Item>
    <name>HomeOwner</name>
    <value>OwnerOccupier_HomeOwner</value>
    <applyForHB>false</applyForHB>
    <householdType>OwnerOccupier</householdType>
    <paymentType requireLandlordAccount="false" requireClaimaintAccount="false"/>
    <landlordDetailsRequired>false</landlordDetailsRequired>
    <rentDetailsRequired>false</rentDetailsRequired>
    <propertyDetailsRequired>false</propertyDetailsRequired>
    <propertyRoomDetailRequired>false</propertyRoomDetailRequired>
    <propertyMiscDetailRequired>false</propertyMiscDetailRequired>
    <rentServiceDetailsRequired>false</rentServiceDetailsRequired>
    <rentReferenceNumberRequired>false</rentReferenceNumberRequired>
    <UCBehaviour>false</UCBehaviour>
  </Item>
  
  </LivingSituation>

The following elements are responsible for different behaviours:

Element	What does it do
applyForHB	If true this will set the ApplyForHB marker in the XML we send in the XML to the back office telling it the person is applying for Housing Benefit. A home owner will not claim Housing Benefit and thus it is set to false.
householdType	This is the value (from a set list in the benefit schema) that will be passed for this option. I.e. Home owner is OwnerOccupier, a Private Landlord is simply Private.
paymentType	This is the only option that two attributes. The first is requireLandlordAccount. If set to true it will ask for the landlord's bank account details. The second is requireClaimantAccount. If set to true it will ask for the claimant's bank account details. Hence both are false in the home owner situation.
landlordDetailsRequired	If true it will ask for details of who their landlord is.
propertyDetailsRequired	If true it will ask for details like whether the property is detached/furnished etc.
propertyRoomDetailRequired	If true it will ask for a breakdown of the rooms in the property.
propertyMiscDetailRequired	If true it will for ask about whether the landlord is a former partner etc.
rentServiceDetailsRequired	If true it will ask for details of service charges that are part of their rent.
rentReferenceNumberRequired	If true it will ask for their rent account/reference number. Used for Council Tenants/Housing Association claimants.
UCBehaviour	We have made it possible for a council to set any living situation type to be able to exempt from the normal UC behaviour or not. Thereby future proofing the software by having the means to add / change this adhoc for any living situation the customer may choose. In order to make a living situation behave like supporting people did previously the following tag needs to be added to the living situation section for that type: <UCBehaviour>true</UCBehaviour>