RPO Localisation
Beyond the settings / localisation already mentioned in each of the forms, there is additional localisation, which IEG4 update as a part of your implementation, for Revenues Process Orchestration to enable council specific behaviours.
Localisation Settings
The following settings, which are those IEG4 set, span the Revenues forms and control key elements of behaviour:
Localisation Configuration Options
Example
Description
BaseUrl
URL
URL of the back office system e.g. Integrator, Capita ABC, Web Broker
System
TEST
NEC Specific System Parameter
Domain
RBTEST3
NEC Specific System Parameter
LengthOfAccountNumber
WithoutCheckDigit
7
Some APIs don’t use the full account number. This tells the system the number of digits without the check digit.
NumberOfDaysTo
SuspendNewAccount
14
For NEC you can suppress billing after automation. This is the number of days to suppress billing for.
ReasonForAccountSuspension
SB
For NEC you can suppress billing after automation. This is the reason code to send in the API.
RollUpChangeInCircs
1
This ensures if Benefits forms are in place too, that we automate a change in circumstance where the person is on benefits and reporting someone as moved out.
SourceId
IEG4
This is only relevant for Capita. It explains where the data has come from.
SourceUserId
IEG4
This is only relevant for Capita. It explains where the data has come from.
UserId
aisdba
This is only relevant for Capita. This user needs to be a valid user in Academy. aisdba is the Database Administrator and thus will exist and have super user permission.
NumberOfDaysToCheckForExistingAccount
0
This setting ensures our system looks to see if there is already a VOID account in place on the date someone else is reporting they moved in. It is set to 0 to ensure that if they report the same say i.e. not different by a day, the system automatically makes them liable.
This setting is NEC specific.
NumberOfDaysToSuspend
AccountForBalanceTransfer
NULL
For NEC you can suppress billing after automation where benefit was in place. To ensure the transfer account process takes account of the subsequent benefit calculation.
DefaultNotepadChapter
General
For NEC you can update specific notepad chapters. This setting controls which is used.
NumberOfDaysTo
SuspendCoaMovingInPlan
14
These are Change of Address specific settings that allow billing to be suppressed for a different number of days where necessary for Move In, Move Out and Move Within
NumberOfDaysTo
SuspendCoaMovingOutPlan
14
These are Change of Address specific settings that allow billing to be suppressed for a different number of days where necessary for Move In, Move Out and Move Within
NumberOfDaysTo
SuspendCoaMovingWithinPlan
14
These are Change of Address specific settings that allow billing to be suppressed for a different number of days where necessary for Move In, Move Out and Move Within
NumberOfDays
ToSuspendDirectDebitPlan
4
This is a setting that sets the max time to suppress billing for a DD.
NumberOfDaysTo
SuspendSpdLivingAlonePlan
4
This is a setting that sets the max time to suppress billing for a SPD where they live alone.
NumberOfDaysToSuspend
SpdOccupantMovedInPlan
4
This is a setting that sets the max time to suppress billing for a SPD where someone has moved in
NumberOfDaysToSuspend
SpdOccupantMovedOutPlan
4
This is a setting that sets the max time to suppress billing for a SPD where someone has moved out
NumberOfDaysToSuspend
SpdOccupantPassedAwayPlan
4
This is a setting that sets the max time to suppress billing for a SPD where someone has passed away
LengthOfPropertyReference
14
This tells our system the back office’s standard property reference length
EmptyFurnishedDiscountCode
PCLBUNOCC0
Back office applications can have codes that represent different discount types. This is an example of a code for an empty but furnished discount.
EmptyUnfurnishedDiscountCode
PCLCEMPTY
Back office applications can have codes that represent different discount types. This is an example of a code for an empty and unfurnished discount.
SinglePersonDiscountCode
01
This is the code used where applicable to set a SPD
NumberOfDaysTo
SuspendCtdAdaptedPropertyPlan
14
These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for Disabled Band Reduction.
NumberOfDaysToSuspend
CtdDisregardAllButOnePlan
14
These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for a Disregard discount as one person is liable.
NumberOfDaysToSuspend
CtdDisregardAllNotSamePlan
14
These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for two or more different disregards
NumberOfDaysToSuspend
CtdDisregardAllSamePlan
14
These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for a Disregard for all occupiers i.e. exemption.
NumberOfDaysToSuspend
CtdEmptyPropertyPlan
14
These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has applied for an empty property discount.
NumberOfDaysToSuspendSpd
AdjustedEffectiveFromDate
14
These are discount specific suppressions that enable billing to be suppressed in different use cases. This one is for a person that has been awarded an SPD as the result of a change.
DirectDebitsBouncedNotepadChapter
ARUDCANX
Where NEC is the back office this is the default notepad chapter to check for bounced direct debits.
UpdatePersonDeceasedReasonCode
DECEASED
This is the deceased reason code as held in NEC, which can differ bizarrely from one council to another.
DirectDebitsBouncedTransactionCode
D/D CASH
Where Civica/Capita are the back office this tells the form the transaction type to check for.
DirectDebitsBouncedWithinDays
365
This tells the form the number of days back from today, for the current financial year, to check for bounced direct debit transactions.
NoOfBouncedTransaction
2
This tells the form the count of transaction types within the number of days specified above to look out for.
UseCheckForOutstanding
RecoveryBalances
1
With Special Arrangements if set to 1 this will ensure the details of existing outstanding recovery balances are retrieved.
FailProcessDueToBenefits
0
Capita only: If set to 1 then within the SPD form a message will display and the form cannot be submitted where the Has Benefits indicator is set to Y. The same applies to the COA form for Move Out (and Within where the moving out account has benefits). For Move In (and the incoming address of Move Within) the form can be submitted but the process will fail if benefits are in place and create an exception.
CoaBillingEnabled
1
This will ensure bills are calculated and generated for COA on the accounts ended/opened if set to 1.
SpdBillingEnabled
1
This will ensure bills are calculated and generated for SPD on the accounts ended/opened if set to 2
NumberOfDaysBeforeReview
365
This ensures that a review date is set 365 days after the effective date
MaximumNumberOfDays
AllowedForBackdating
90
This is the maximum number of days the API update for Single Person Discount will allow. So if a person applies for a single person discount with an effective date of 6 months ago, it will default to 3 months ago if set to 90 days like in this example. NOTE: only applies to NEC
AllowWhenInactive
0
If set to 1, Direct Debits can be set up on the current account.
CheckBankAccountExists
0
If set to 1, we will check if the bank account already exists. This is a NEC specific function.
Direct Debit Recovery Messages
It's possible within the IEG4 forms, to intelligently display different messages based upon a person's recovery stage for their account. The following table illustrates an example of this.
StageCode
StageName
Enabled
AllowDirectDebit
Message
L
Liability Order
1
0
S
Summons
1
0
B
Bill
1
1
R
First Reminder
1
1
Where:
Stage Code is the back office identifier for a recovery stage
Stage Name is the name of the recovery stage
Enabled means a check is happening for that stage
Allow Direct Debit if set to 1 means a person can still set up a Direct Debit. But not if set to 0 for the given recovery stage
Message is what should be presented where the customer cannot set up a Direct Debit
Direct Debit Frequency Options
The following is an example Direct Debit localisation file. This controls:
The frequency options e.g. Annually, Monthly, Half Yearly etc.
The code specific to the frequency if applicable e.g. A, M, S are the codes for the above
The options available for the frequency e.g. for Monthly:
1st of the month - 10 instalments
1st of the month every month
The code specific to the frequency option e.g. for 1st of the month every month the code the back office API expects is DD01NS
Not only do these effect the integration but also the options the customer can select in the forms:
Special Arrangement - Direct Debit - Frequency Options
The following is an example Direct Debit localisation file for the Special Arrangement form . This controls:
The frequency options e.g. Annually, Monthly, Half Yearly etc.
The code specific to the frequency if applicable e.g. A, M, S are the codes for the above
The options available for the frequency e.g. for Monthly:
5th
15th
25th
The code specific to the frequency option e.g. for 5th of the month every month the code the back office API expects is DD
Local Disregard Details
To be able to support differences in the codes back office systems have for disregard codes, we have the ability to hold different codes for each.
Local Exemption Details
To support differences in these from one council/back office system to another, we have configuration to link different exemption types to the back office API codes. The following is example configuration:
Last updated
Was this helpful?