# Form Configuration (Files)

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

{% hint style="danger" %}
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>
{% endhint %}

For the eClaim, there are 7 and these files are covered below: &#x20;

## evidencerules.xml&#x20;

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.&#x20;

{% hint style="info" %}
You don't need to ever change this file. It's just to explain you can if you want to.
{% endhint %}

### Example file

Note - this file is bigger than this - we've taken an excerpt.&#x20;

```
<Evidences>
  <Evidence resourceId="Rule_Identity">
    <Text><![CDATA[
			<p><b>Evidence of 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 you from a solicitor, Her Majesty's Revenue and Customs, doctor, social worker or probation officer.</p>
			]]></Text>
    <Rules>
      <Rule>
        <XPath>eForm/page[@id='whoareyou']/Surname</XPath>
        <Operator>Exists</Operator>
      </Rule>
    </Rules>
  </Evidence>
  <Evidence resourceId="Rule_Partner_Identity">
    <Text><![CDATA[
			<p><b>Evidence of partner 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 you from a solicitor, Her Majesty's Revenue and Customs, doctor, social worker or probation officer.</p>
			]]></Text>
    <Rules>
      <Rule>
        <XPath>eForm/page[@id='YourPartnerContactDetails']/LastName</XPath>
        <Operator>Exists</Operator>
      </Rule>
    </Rules>
  </Evidence>
  <Evidence resourceId="Rule_NI_Number">
    <Text><![CDATA[
			<p><b>Evidence of 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 N.I. number. We need to see one of these documents.</p>
			]]></Text>
    <Rules>
      <Rule>
        <XPath>//page[@id='whoareyou']/NationalInsuranceNumber</XPath>
        <Operator>Exists</Operator>
      </Rule>
      <Rule>
        <XPath>//page[@id='YourPartnerContactDetails']/natIns</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 eClaim based upon the person's circumstances provided.&#x20;

For example, there is an evidence resource called Rule\_Identity.&#x20;

```
  <Evidence resourceId="Rule_Identity">
```

And within that section there is a Rules section that outlines the rules&#x20;

```
      <Rule>
        <XPath>eForm/page[@id='whoareyou']/Surname</XPath>
        <Operator>Exists</Operator>
      </Rule>
```

The rule is saying if there is a surname present for the claimant, which there always will be, ask for proof of identity.&#x20;

## livingsituation.xml&#x20;

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

a) What appears in this list:

![](/files/-Mgtb_31YZkkubg3Oe8R)

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                 | <p>We have made it possible for a council to set <strong>any</strong> 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:</p><p>\<UCBehaviour>true\</UCBehaviour></p> |

## ratesandvalueslcts.xml&#x20;

### Example file

```
<Rates>
  <Rate id="NonDependantWorkingHours" value="16"/>
  <Rate id="DlaCareHigh" value="79.15"/>
  <Rate id="DlaCareMiddle" value="53.00"/>
  <Rate id="DlaCareLow" value="21.00"/>
  <Rate id="DlaMobilityHigh" value="55.25"/>
  <Rate id="DlaMobilityLow" value="21.00"/>
  <Rate id="PipDailyLivingStandard" value="53.00"/>
  <Rate id="PipDailyLivingEnhanced" value="79.15"/>
  <Rate id="PipMobilityStandard" value="21.00"/>
  <Rate id="PipMobilityEnhanced" value="55.25"/>
</Rates>
```

&#x20;Enables you to change the rates of:

* DLA Care
* DLA Mobility
* PIP Daily Living&#x20;
* PIP Mobility

As and when they change annually.&#x20;

{% hint style="warning" %}
Please remember to update these before each April.
{% endhint %}

This file also has the ability, should it ever change, to update the number of hours that are taken into account before a Non-Dependant Deduction is taken.&#x20;

## vulnerabilitytype.xml&#x20;

This file is specific to Local Council Tax Support.&#x20;

It enables a council to set a list of different circumstances that should be exempt from the local council tax support scheme in the same way pensioners are.&#x20;

### Example file

The following illustrates an example file with four different vulnerability options:

```
<VulnerabilityType>
  <Item>
    <name/>
    <value/>
  </Item>
  <Item>
    <name>I am a lone parent with at least one children under 5</name>
    <value>VulnerabilityType1</value>
  </Item>
  <Item>
    <name>I have been resident in a care home or hostel previously</name>
    <value>VulnerabilityType2</value>
  </Item>
  <Item>
    <name>I am in receipt of Disability Living Allowance</name>
    <value>VulnerabilityType3</value>
  </Item>
  <Item>
    <name>I am in receipt of Bereavement Allowance</name>
    <value>VulnerabilityType4</value>
  </Item>
</VulnerabilityType>
```

Simply remove any items or edit the above file if you want to change the default options. These four options end up showing as follows:

![](/files/-MgtgewTtQQHeU632L7o)

You can add additional options by simply adding another section like the following below the above:

```
<Item>
    <name>Your New Vulnerability Type</name>
    <value>VulnerabilityType5</value>
  </Item>
```

{% hint style="info" %}
The vulnerability file and the resulting list are only shown if the setting **LCTS\_SupportVulnerablePeople** is set to true.
{% endhint %}

## cvwarningconfiguration.xml&#x20;

This file enables councils using the CallValidate functionality to present a warning to staff based upon the responses back from the TransUnion CallValidate API call.

### Example file

```
<ArrayOfWarningConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <WarningConfiguration>
    <Type>AddressPicklistWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
  <WarningConfiguration>
    <Type>BankAccountClosedWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
  <WarningConfiguration>
    <Type>CardAccountClosedWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
  <WarningConfiguration>
    <Type>NamePicklistWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
  <WarningConfiguration>
    <Type>NonGBRCardWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
  <WarningConfiguration>
    <Type>PAFNonValidWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
  <WarningConfiguration>
    <Type>PrepayWarning</Type>
    <IsActive>true</IsActive>
    <EnforceValidation>false</EnforceValidation>
  </WarningConfiguration>
</ArrayOfWarningConfiguration>
```

There are the following types that can be presented as warnings:

* AddressPickListWarning
* BankAccountClosedWarning
* CardAccountClosedWarning
* NamePickListWarning
* NonGBRCardWarning
* PAFNonValidWarning
* PrepayWarning

You can choose to make them active or not in this file.&#x20;

## evidencerulescoactiva.xml&#x20;

The evidencerulescoactiva.xml file controls the evidence paragraphs presented to customers, like the evidencerules.xml file but with additional behaviours to dynamically reflect Risk Score.

{% hint style="info" %}
You don't need to ever change this file. It's just to explain you can if you want to.
{% endhint %}

The file is largely the same as the evidencerules.xml file but at the top it has a dedicated section that enables the evidence requested to be set for each risk score.&#x20;

### Example file

For example - the following shows the different paragraphs that are applicable where the risk score is 1:

```
 <Risk riskValue="1">
      <Evidences>
        <Evidence isheader="true">Rule_Header_High</Evidence>
        <Evidence>Rule_NI_Number</Evidence>
        <Evidence>Rule_Identity</Evidence>
        <Evidence>Rule_Partner_Identity</Evidence>
        <Evidence>Rule_Student</Evidence>
        <Evidence>Rule_SavingsAndInvestments</Evidence>
        <Evidence>Rule_Earnings</Evidence>
        <Evidence>Rule_SelfEmployedEarnings</Evidence>
        <Evidence>Rule_OtherIncome</Evidence>
        <Evidence>Rule_Benefits</Evidence>
        <Evidence>Rule_RentOrTenancy</Evidence>
        <Evidence>Rule_OtherMoneyPaidOut</Evidence>
        <Evidence>Rule_CurrentAddress</Evidence>
        <Evidence>Rule_ChildCareCosts</Evidence>
        <Evidence>Rule_PassportBenefit</Evidence>
        <Evidence>Rule_NonDep_Income</Evidence>
        <Evidence>Rule_NonDep_PassportBenefit</Evidence>
        <Evidence>Rule_Universal_Credit</Evidence>
      </Evidences>
    </Risk>
```

The section after that then covers the rules on which evidence to show from the eligible paragraphs set above. I.e. What are the person's circumstances establishes the evidence blocks applicable. A further check is then done against the risk score rules to see if that evidence block should be shown. So a person would be asked for proof of earnings if their risk score was 1 because this is present in the risk rule for 1:

```
<Evidence>Rule_Earnings</Evidence>
```

But it wouldn't be shown where the risk score was 12 because the paragraph for Rule\_Earnings does not exist in this risk group:

```
<Risk riskValue="12">
  <Evidences>
    <Evidence isheader="true">Rule_Header_Low</Evidence>
    <Evidence>Rule_NI_Number</Evidence>
    <Evidence>Rule_Identity</Evidence>
    <Evidence>Rule_Partner_Identity</Evidence>
    <Evidence>Rule_Student</Evidence>
    <Evidence>Rule_SavingsAndInvestments</Evidence>
  </Evidences>
</Risk>
```

## evidencerulesxantura.xml

This file is identical to the evidencerulescoactiva.xml one, except that:

a) It is where the Xantura RBV service is in use

b) It has a risk score range of 1-15 rather than 1-12


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ieg4.gitbook.io/citizen-facing-forms/benefit-forms/untitled/configuration-files.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.