🧑‍🤝‍🧑
Citizen Facing Forms
Council Wide Digital PlatformNo Code Service CreationGCloud Information
  • Introduction
  • LGaaP Services
  • This Guide
  • Platform Functionality
    • Platform Functionality
    • Integration Error Guidance
  • 💙Benefit/Welfare Forms
    • Introduction
    • eClaim
      • Local Council Tax Support
      • Universal Credit
      • Dynamic Evidence
      • Fast Track
      • Benefit App Integration
      • EDMS Integration
      • Reporting
      • Form Level Settings
      • Form Configuration (Files)
      • Value Add Functionality
        • Call Validate - ID Checking
        • Risk Based Verification
          • Settings
          • Configuration (Files)
    • Calculator
      • Settings
      • Calculator Configuration
    • eChanges
      • Intelligent Change Processing
      • Universal Credit
      • Dynamic Evidence
      • Fast Track
      • Benefit App Integration
      • EDMS Integration
      • Form Level Settings
      • Form Configuration (Files)
      • Value Add Functionality
        • Risk Based Verification
          • Settings
          • Configuration (Files)
    • HBAA - Full Case Review
      • Intelligent Change Processing
      • Universal Credit
      • Review Your Claim
      • Dynamic Evidence
      • Benefit App Integration
      • EDMS Integration
      • Form Level Settings
      • Form Configuration (Files)
    • Self Employed Earnings
      • Settings
      • Configuration (Files)
    • Free School Meal Holidays
      • Integrations
        • Ordnance Survey
        • OpenProcess
          • Dynamic Notifications
          • Issuing Vouchers
        • Loqate - Bank Check
        • DfE - ECS
        • Benefit Check
      • Checking integrations
      • BACS Extract
      • Data Extract
    • Additional Services
  • 💳Council Tax Forms
    • Council Tax Services
      • Introduction
      • Direct Debit
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
        • Direct Debit Email
      • Single Person Discount
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
      • Change of Address
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
        • Notification Configuration
      • Discounts / Exemptions
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
        • Configuration
      • Special Arrangements
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
      • Request a Refund
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
        • Settings
      • Local Council Tax Support
        • Real-time Checks
        • Back-office Automation
        • EDMS Automation
      • RPO Localisation
      • Additional Services
      • Landlord Voids & Lets Processing
        • Real-time Checks
        • Back-office Automation
        • File Format
        • EDMS Notification
  • 🚚Bin / Waste Forms
    • Introduction
    • Report a Missed Bin
      • Back Office Integration
      • Settings
      • Missed Bin Configuration
    • Request a Bin
      • Back-office integration
      • Settings
      • Request a Bin Configuration
    • Bulky Waste Collection
      • Back-office integration
      • Settings
      • Bulky Waste Configuration
        • Bulky Waste configuration - new April 2024
    • Request Assisted Collection
      • Back-office integration
      • Settings
      • Assisted Collection Config
    • Clinical Waste Collection
      • Back-office integration
      • Settings
      • Clinical Configuration
    • Garden Waste Subscriptions
      • Garden Waste Form
      • Back-office integration
      • Settings
    • Waste Localisation
    • Agent Payments
  • 🏭Business Rates Forms
    • Direct Debit
      • EDMS Integration
      • Settings
      • Configuration
    • Relief Application
      • EDMS Integration
      • Settings
    • Moves, Reliefs and Pay
      • EDMS Integration
      • Settings
    • Additional Services
  • 🏪Licensing Forms
    • Temporary Event Notice App
      • Back-office Integration
      • EDMS Integration
    • Taxi Driver - Licence Renewal
      • Back-office Integration
      • EDMS Integration
      • Settings
    • Taxi Driver - Vehicle Licence
      • Back-office Integration
      • EDMS Integration
  • 💚Social Care Forms
    • Social Care Financial Assessments
      • Settings
      • SCFA Calculator
      • EDMS Integration
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Benefit/Welfare Forms
  2. eClaim

Form Level Settings

The following lists all of the settings in the eClaim form and what they do.

Name

Description

SourceId

This setting tells the back office the source of the claim and should be IEG4

SourceIdMode

This setting has three modes and is used for the NEC back office. It means that you can control what is shown in External Items for claims. Option 1 - SourceIdMode of “eFormReference” = means the IEG4 form reference will be sent to NEC as the Source Option 2 - SourceIdMode of “ClaimantName” = means the claimant's name will be sent to NEC as the Source Option 3 - SourceIdMode of “Composite” = means that the form ref and claimant name will be sent to NEC as the Source

SourceUserId

This should be set to IEG4User

UserId

This should be set to the system admin user within Capita = aisdba For Capita / Civica it doesn't matter what this is

LocalHousingAllowanceAuthority

This will always be true as it is a legacy setting from prior to full LHA roll out.

RbvEnabled

If true Risk Based Verification will be enabled.

RbvSource

This will be either Coactiva (TransUnion RBV) or Xantura (Xantura RBV) which are the two different RBV suppliers.

RbvSourceUrl

This will be the URL for the specific RBV service. This will be different between test and live.

RbvSourceCertificate

This will contain an encrypted version of the security certificate that allows communication between the eClaim and the RBV service.

RbvSourceCertificatePassword

This is the password for the digital security certificate

RbvAdvisorLocalAuthorityCode

This will be the council's LASER code (used for DWP etc.)

LowRiskShowUpload

Where Evidence Uploads are permitted this setting, if TRUE will mean low risk claims can upload evidence.

MediumRiskShowUpload

Where Evidence Uploads are permitted this setting, if TRUE will mean medium risk claims can upload evidence.

HighRiskShowUpload

Where Evidence Uploads are permitted this setting, if TRUE will mean high risk claims can upload evidence.

DisableAnythingElseCharacterValidation

If set to FALSE then the contents of the box on the 'Anything Else' page will be validated against the regular expression (in the next setting). The reason that you would do this is because some back office applications fail if values like £ symbols are sent in the XML. If this is false you can set a regular expression to limit what is allowed.

ValidationExpression

This is the box where the actual regular expression is placed. For example the following: ^[0-9A-Za-z\.\,\',\r,\n,\r\n ]+$ Will allow text containing letters, numbers, full stops, commas, apostrophes, new lines only.

AppliedForUCWithClaimedFunctionality

If this is true claimants that state they've applied for Universal Credit but have not yet heard if they are successful, will be treated as if they will be successful. I.e. no questions about rent / landlord etc. unless they're in an exempt category of tenancy e.g. hostel.

DisableUniversalCreditEvidenceRule

If set to FALSE then this setting will ensure evidence of Universal Credit is requested on the evidence page where they have said they are in receipt of Universal Credit.

ShowEqualities

If set to TRUE then this setting will ensure an Equalities page is present between the Evidence and Declaration pages.

MaxAgeOfAdult

This setting defaults to 120 and controls the maximum age an adult can be. It's designed to prevent citizens accidentally typing a date of birth of 01/01/1080 for partners/non deps instead of 01/01/1980.

MinAgeOfAdult

This setting is designed to ensure partners/non deps are not aged less than 16. It defaults to 16.

MaxAgeOfDependant

This setting is exclusive and because children can can child benefit up to 19 the value entered here should be 20.

MaxWhoAreYouAge

This setting defaults to 120 and controls the maximum age an adult can be. It's designed to prevent citizens accidentally typing a date of birth of 01/01/1080 for claimants instead of 01/01/1980.

MinWhoAreYouAge

This setting is designed to ensure claimants are not aged less than 16. It defaults to 16.

ShowCompletedByDetails

If set to TRUE when the applicant says the form is being completed by someone else a set of questions about who they are and why they're completing it is asked.

IncludeCoverSheetStart

Mainly relevant when either RBV or Call Validate or both are enabled. This sheet shows when the form was started, completed, the risk score and details of the ID/Bank checks done with CallValidate. This page appears at the front of the PDF if this is set to TRUE.

IncludeCoverSheetEnd

Mainly relevant when either RBV or Call Validate or both are enabled. This sheet shows when the form was started, completed, the risk score and details of the ID/Bank checks done with CallValidate. This page appears at the end of the PDF if this is set to TRUE.

ShowFreeSchoolLunches

If TRUE the eClaim will ask if the claimant would like to apply for free school lunches for children that are added to their claim.

ShowClothingGrants

If TRUE the eClaim will ask if the claimant would like to apply for school clothing grants for children that are added to their claim.

CTaxAccountMaxLength

This setting allows the council to ensure that the council tax account number is restricted in length to the actual maximum size of a council tax account.

ShowAboutWorkingPages

If set to TRUE then the pages asking about work/self employment will be shown even if the person is in receipt of Universal Credit.

Under22LeavingCareQuestion

If TRUE then the claimant will be asked if they were previously in care (a care leaver) if they are under 22.

25to35RehabilitationQuestion

If TRUE and the person is aged between 25-35 the claimant will be asked if they were previously resident in a hostel etc. and are being rehabilitated into the community.

LandlordAddressAgentDetails

If TRUE this ensures that the landlord's agent details are passed in the XML to Capita. This is a Capita specific setting.

AlwaysCTBOnly

If TRUE this ensures that no claims are sent to your benefit system with HB on them.

RiskCheckConfirmationPanel

If TRUE a panel will appear on the bottom of the About Your Claim page that asks if they agree to their info being used to do checks e.g. RBV.

CapitalizeNbpXmlNames

If TRUE names entered will be capitalised when pushed into the back office.

ApplicantEmailIncludeFormPDF

If TRUE the email sent to the applicant as a receipt will include the eClaim form as a PDF.

ShowContactMeByEmailOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeByPostOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeBySmsOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeByPhoneOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeByMinicomOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeByLetterOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeByLetterDifferentFormatOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeViaCouncilOfficeOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

ShowContactMeByOtherOption

If TRUE an option will appear at the bottom of the About Your Claim page asking if they'd like to be contacted by this method.

NbpHbBackOffice

This setting tells our form which back office you have. The options are NEC, Civica, Capita

EvidenceUpload

If TRUE this setting will allow customers to upload evidence as a part of the claim form prior to submission.

AfterActionEvidenceUpload

If TRUE this setting will allow customers to upload evidence as a part of the claim form after submission. This setting will also ensure that evident uploaded pre-submission is tracked and the customer told what's missing when they submit their claim.

CatchAllEvidenceUpload

If TRUE this setting will allow customers to upload evidence adhoc that is not in the list of evidence requested. This is mainly for customers uploading evidence of the same type as previously submitted after submission.

LCTSEnable

This setting should always be true as it was introduced in 2012 ahead of 2013 when LCTS was first put in place.

LCTS_ProtectPensioners

This setting will always be true.

LCTS_SupportVulnerablePeople

This setting will be true if you support vulnerable adults as a part of your LCTS scheme.

LCTS_RemoveSAR

IF TRUE this means any claimants of working age will not be given the option to apply for Second Adult Rebate.

LCTS_DisableBackdating

If TRUE claimants will be unable to claim any backdating for LCTS.

LCTS_RemoveOwnerOccupierLivingSituation

IF TRUE then the owner occupier option will not appear for working age claimants.

LCTS_BackdatingPeriodMonths

If you do allow backdating as a part of your LCTS scheme you can set the number of months here. This means you can support different levels from the standard number of months.

LCTS_EnforceCapitalEvidenceThreshold

If TRUE this means evidence of Capita will be requested if the threshold is exceeded (see next setting)

LCTS_CapitalEvidenceThreshold

This is monetary value that is solely about triggering if evidence of capital is request. The default is 6000

LCTS_EnforceCapitalAllowedThreshold

If TRUE this means the user will not be permitted to proceed further with their application.

LCTS_CapitalAllowedThreshold

This is monetary value that will prevent the user proceeding further if the total value of their capital is higher than it. The default is 16000

LCTS_ConsiderCapitalForPassportedClaims

If TRUE claimants in receipt of passported benefits will still be asked for proof of Capital.

NonLCTS_EnforceCapitalAllowedThreshold

If TRUE this means the user will not be permitted to proceed further with their application for non LCTS claims e.g. pensioners.

NonLCTS_CapitalAllowedThreshold

This is monetary value that will prevent the user proceeding further if the total value of their capital is higher than it. The default is 16000

NumberOfChildren

This number is the maximum number of children that can be on a claim. The default is 20 but can be increased to whatever you like.

NumNonDependants

This number is the maximum number of non-dependants that can be on a claim. The default is 5 but can be increased to whatever you like.

NumberOfBankAccounts

This number is the maximum number of bank accounts that can be on a claim. The default is 6 but can be increased to whatever you like.

NumNSCerts

This number is the maximum number of national savings certificates that can be on a claim. The default is 5 but can be increased to whatever you like.

NumStocksShares

This number is the maximum number of stocks/shares that can be on a claim. The default is 5 but can be increased to whatever you like.

NumOfOtherSavings

This number is the maximum number of other savings that can be on a claim. The default is 5 but can be increased to whatever you like.

UploadWhiteList

This is a setting for the Upload of evidence in forms. This controls the types of files that are permitted. This list would normally only be used if a specific type of file is allowed, as the black list is present below to prevent any disallowed file types. File types are added using their extension and multiple types can be added by separating them with a comma. For example if only MS Word documents were allowed you could add the following: doc,docx

UploadBlackList

The black list is the list of files which are NOT allowed to be uploaded. This allows specific file types known to be commonly used for viruses to be listed

UploadSizeLimit

This allows one to specify the maximum size of any single file in bytes. I.e. 10000 is roughly 10MB

FastTrackHighRisk

If 'FastTrack' is enabled this setting allows you to provide this option if the claim is high risk by setting it to TRUE.

FastTrackMediumRisk

If 'FastTrack' is enabled this setting allows you to provide this option if the claim is medium risk by setting it to TRUE.

FastTrackLowRisk

If 'FastTrack' is enabled this setting allows you to provide this option if the claim is low risk by setting it to TRUE.

SelfEmploymentFormUrl

This is the URL for the self employed earnings for in your forms environment

UseSelfEmployedEarningsForm

If TRUE then when a person indicates they are self employed, they will be taken to the fully integrated self employed form/calculator.

CVEnabled

If TRUE it means that CallValidate is enabled. This enables real time ID checks for the claimant and partner. As well as real time confirmation that the bank account details they've provided relate tot hem.

CVURL

This is the URL for the CallValidate service. There is a different URL for test/live.

DateTextBoxMode

This setting is only present where the data calendar picker is enabled. The default is 'picker'.

CapitalizeNbpXmlNames

This setting will mean that names captured in the form are passed in capitals. Some back office applications tend to only use Capitals. Hence this can enable uniformity. The default is false. Update to true if you want this behaviour.

NonLCTS_EnforceCapitalAllowedThreshold

This setting enables you to have a different capital threshold where the applicant's claim includes Housing Benefit.

NonLCTS_CapitalAllowedThreshold

This value is the capital threshold where it is a Housing Benefit claim. The default is 16000.

PreviousReportingNextForm Configuration (Files)

Last updated 1 year ago

Was this helpful?

💙