Notification Configuration

An optional function within the Change of Address form is the ability to notify multiple other departments about the change of address.

Within Form System Management, you can modify which departments are available to choose and also the email addresses to send the details to.

This is done within the Files area of Form System Management. First select the Change of Address form. There will be a file called:

configuration/notificationareas.xml

The purpose of this file is to control the behaviour of the notification areas page AND to control the config/content of emails to different organisations.

The file is made up of all ‘Areas’ or departments to which the council wants the citizen to be able to notify the change of address to.

The file is an XML file with each <Area> section controlling the behaviour for that department. To provide an example the following is the Council Tax ‘Area’ section of the XML file:

<Area>
<!-- use for the ID of the check box control --> 

<Identifier>CouncilTax</Identifier>

<!-- modes: Optional, Off, Always --> 

<Mode>Always</Mode>

<Name>
<Default>Council Tax</Default>
<ResourceKey>CouncilTaxName</ResourceKey> </Name>
<Wording>

<Default>Names of resident moving properties, Old address, new address and 
Contact numbers, DOB, Date of move, CT Ref num.</Default>

<ResourceKey>CouncilTaxWording</ResourceKey> </Wording>

<TickBoxWording>

<Default>[Tick to notify this department]</Default>

<ResourceKey>CouncilTaxTickBoxWording</ResourceKey> 

</TickBoxWording>

<CheckBoxHelp>

<Default>If you add help here it will show on the form for this specific area</Default>

<ResourceKey>CouncilTaxCheckBoxHelp</ResourceKey> 
</CheckBoxHelp>

<Notifications>

<Notification>

<Type>Email</Type>
<Subject>Notification of change of address</Subject> 
<Body>Please see attached</Body> 
<To>default@default.gov.uk</To>
<Cc></Cc>
<Bcc></Bcc>
<Attachments>

<Attachment> 
<Type>DataDocument</Type> 
<Name>FORMPDF</Name>
</Attachment> 

</Attachments>
</Notification> 

</Notifications>

</Area>

Notification Mode

There are some things to explain: <Mode> tags

This has three allowed values:

Always

If set to always the question about this department will not appear and an email will always be sent to the department in question using the email address within the Notification section of the file for the given area.

Optional

If set to optional then the citizen will see this as an option with the online form to opt in to have their move details shared

Off

Will hide the department from the form and no emails will be sent to them

<Name> tags

Here is where you can change the name of the department i.e. if I wanted it to say Revenues Department instead of Council Tax I would update the tag as follows:

<Name> <Default>Revenues Department</Default> <ResourceKey>CouncilTaxName</ResourceKey>

</Name>

<Wording> tags

These tags are ONLY to control what appears on the online form beside the department in question and only where the mode is Optional.

So for Adult Social Care the following might be the wording: <Wording>

<Default>If you receive Adult Social Care Services.</Default>

<ResourceKey>AdultSocialCareWording</ResourceKey> </Wording>

<TickBoxWording> tags

Per above, this is simply to be able to modify what is shown beside the check box. I.e. in the above the tags are updated as:

<TickBoxWording> <Default>[Tick to notify this department]</Default> <ResourceKey>CouncilTaxTickBoxWording</ResourceKey>

<Notification> tags

This is where you control what the subject line and body of the email are as well as the email address to send it to. E.g. if I wanted it to go to counciltax@ieg4.gov.uk, have a subject line of Council Tax Move Details and a body of:

"Please find details of the move in the attachment."

One would update the tags as follows:

<Notification>
<Type>Email</Type>
<Subject>Council Tax Move Details</Subject>
<Body>Please find details of the move in the attachment.</Body>
<To>counciltax@ieg4.gov.uk</To>

PreviousSettings NextDiscounts / Exemptions

Last updated 1 year ago

Was this helpful?

Notification Configuration

An optional function within the Change of Address form is the ability to notify multiple other departments about the change of address.

Within Form System Management, you can modify which departments are available to choose and also the email addresses to send the details to.

This is done within the Files area of Form System Management. First select the Change of Address form. There will be a file called:

configuration/notificationareas.xml

The purpose of this file is to control the behaviour of the notification areas page AND to control the config/content of emails to different organisations.

The file is made up of all ‘Areas’ or departments to which the council wants the citizen to be able to notify the change of address to.

The file is an XML file with each <Area> section controlling the behaviour for that department. To provide an example the following is the Council Tax ‘Area’ section of the XML file:

<Area>
<!-- use for the ID of the check box control --> 

<Identifier>CouncilTax</Identifier>

<!-- modes: Optional, Off, Always --> 

<Mode>Always</Mode>

<Name>
<Default>Council Tax</Default>
<ResourceKey>CouncilTaxName</ResourceKey> </Name>
<Wording>

<Default>Names of resident moving properties, Old address, new address and 
Contact numbers, DOB, Date of move, CT Ref num.</Default>

<ResourceKey>CouncilTaxWording</ResourceKey> </Wording>

<TickBoxWording>

<Default>[Tick to notify this department]</Default>

<ResourceKey>CouncilTaxTickBoxWording</ResourceKey> 

</TickBoxWording>

<CheckBoxHelp>

<Default>If you add help here it will show on the form for this specific area</Default>

<ResourceKey>CouncilTaxCheckBoxHelp</ResourceKey> 
</CheckBoxHelp>

<Notifications>

<Notification>

<Type>Email</Type>
<Subject>Notification of change of address</Subject> 
<Body>Please see attached</Body> 
<To>default@default.gov.uk</To>
<Cc></Cc>
<Bcc></Bcc>
<Attachments>

<Attachment> 
<Type>DataDocument</Type> 
<Name>FORMPDF</Name>
</Attachment> 

</Attachments>
</Notification> 

</Notifications>

</Area>

Notification Mode

There are some things to explain: <Mode> tags

This has three allowed values:

Always

Optional

If set to optional then the citizen will see this as an option with the online form to opt in to have their move details shared

Off

Will hide the department from the form and no emails will be sent to them

<Name> tags

Here is where you can change the name of the department i.e. if I wanted it to say Revenues Department instead of Council Tax I would update the tag as follows:

<Name> <Default>Revenues Department</Default> <ResourceKey>CouncilTaxName</ResourceKey>

</Name>

<Wording> tags

These tags are ONLY to control what appears on the online form beside the department in question and only where the mode is Optional.

So for Adult Social Care the following might be the wording: <Wording>

<Default>If you receive Adult Social Care Services.</Default>

<ResourceKey>AdultSocialCareWording</ResourceKey> </Wording>

<TickBoxWording> tags

Per above, this is simply to be able to modify what is shown beside the check box. I.e. in the above the tags are updated as:

<TickBoxWording> <Default>[Tick to notify this department]</Default> <ResourceKey>CouncilTaxTickBoxWording</ResourceKey>

<Notification> tags

"Please find details of the move in the attachment."

One would update the tags as follows:

<Notification>
<Type>Email</Type>
<Subject>Council Tax Move Details</Subject>
<Body>Please find details of the move in the attachment.</Body>
<To>counciltax@ieg4.gov.uk</To>

PreviousSettings NextDiscounts / Exemptions

Last updated 1 year ago

Was this helpful?