# Shared Form Settings



The following is a list of all of the settings that are available, that would be set by you and what they do:

| **Name**                                 | **What does it do?**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| EmailFrom                                | This setting enables you to set the from address for emails sent to customers when forms are submitted etc. E.g. donotreply@yourcouncil.gov.uk                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ToAddress                                | This setting enables you to set an email address that completed online forms should be sent to for internal purposes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| CcAddress                                | This setting enables you to set an additional email address that completed online forms should be sent to for internal purposes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| BccAddress                               | This setting enables you to set an additional email address that completed online forms should be sent to for internal purposes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| SendApplicantEmail                       | This setting when set to true will ensure citizens will be sent an email when submitting their forms.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| EmailEvidenceUploads                     | This setting when set to true will ensure when a form is submitted and evidence was uploaded during its completion, that said evidence is attached to the email sent internally.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ApplicantEmailIncludeAttachments         | This setting when set to true will ensure when a form is submitted and evidence was uploaded during its completion, that said evidence is attached to the email sent to the citizen (provided the SendApplicantEmail and EnableFormPDF setrrings are also enabled).   The Form PDF will also be included as an attachment to the email.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| EnableTopValidationSummary               | If this is set to true a person will be provided with a summary of all issues on a page when they have not completed all mandatory fields or not completed things properly. This will appear at the top of the page.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| EnableBottomValidationSummary            | If this is set to true a person will be provided with a summary of all issues on a page when they have not completed all mandatory fields or not completed things properly. This will appear at the bottom of the page.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| EnableSavedForLaterCustomerEmail         | This setting when set to true will ensure citizens will be sent an email when submitting their forms.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| DisableValidationOnPreviousButton        | This setting when set to true will enable a customer to move backwards from the current page even if there are issues on it. This is useful because sometimes they may have made a mistake and need to go back to change earlier answers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| TransactionNumberMode                    | This setting adds the means to support a **cryptorandom** type for the **reference number** generated in the form. This should be used where you wish to leverage the new functionality provided for the reference number.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| TransactionNumberCasing                  | This allows the reference number to be in upper or lower case. The default is Upper                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| TransactionNumberPrefix                  | Appends a prefix to a reference number e.g. if this setting was set to HB a reference number would be like this: **HB**ZQAPFYXC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| TransactionNumberPostfix                 | Appends a suffix to a reference number e.g. if this setting was set to HB a reference number would be like this: ZQAPFYXC-**CT**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| TransactionNumberRandomNumberMin         |  Sets the minimum number of characters in the form reference                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| TransactionNumberRandomNumberMax         |  Sets the maximum number of characters in the form reference                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| TransactionNumberRandomStringLength      | This is an existing setting and is that which controls the total length of the reference value generated upon starting a form.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| TransactionNumberTransmissionTimeout     | Controls the time in minutes that a session will be kept                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| EnableSecuredRetrieve                    | <p>This is the setting that, if set to <strong>true</strong> means a person requires to provide an additional security phrase on top of the reference number to access their form. </p><p>The user can choose which type of additional phrase to provide from these types:</p><ul><li>Name of your first school</li><li>Your mother's maiden name </li><li>Your National Insurance Number </li><li>A password of choice</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| SecureRetrievePasswordOnly               | When set to true this will mean that a person cannot use Mother's maiden name, NINO or first school as a password. The only option will be 'a password of your choice'. It is this option that is subsequently affected by the settings below                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| SecureRetrievePasswordLengthMin          | This allows you to change the minimum length of the password the user must provide. The default is 8 digits long                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|  SecureRetrievePasswordLengthMax         |  This allows you to change the maximum length of the password the user must provide. The default is 16 digits long.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|  SecureRetrieveNumberMixOfUpperAndLower  |  This setting when **true** means that the password they provide must contain a mixture of upper and lower case characters. I.e. if the password was 8 digits long and set to IEEGFOUR it would not be allowed if this setting was true. But iEEG4FOUR would                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|  SecureRetrieveNumberOfLetters           | This setting controls the number of letters that need to be present within the password the user sets up I.e. you can control the number of letters the customer needs to provide in their password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|  SecureRetrieveNumberOfDigits            | This setting controls the number of numbers that need to be present within the password the user sets up I.e. you can control the number of numbers the customer needs to provide in their password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|  SecureRetrieveNumberOfNonAlphaNumeric   | This setting controls the number of non-letter or number based characters that need to be present within the password the user sets up I.e. you can control the number of special characters the customer needs to provide in their password. E.g. !@£$%^&\*()                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|  SecureRetrieveCaptchaControl            | This provides the ability for you add a captcha control to the form retrieval process. The purpose of this is to completely remove the capability for repeat brute force hacking capability.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| TransactionNumberRandomStringCharacters  | <p>This allows you to set the actual characters that can be used in the random generation of a reference. The default characters used are:</p><p><strong>BCDFGHJKLMNPQRSTVWXYZ</strong></p><p>However, you can use whichever you want e.g.</p><p><strong>abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890</strong></p><p>Would ensure upper, lower, and numbers are used in a reference number. If this were the case for an 8 digit reference number it could look like this:</p><p><strong>4qApf5Xc</strong></p><p>But it important to note that these characters could be anything i.e. you could set this to:</p><p><strong>abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@£$%^&#x26;*()_+|~</strong></p><p>Meaning that an 8 character reference number could be:</p><p><strong>4~Apf5X!</strong></p><p>Where this is the case, the number of combinations for an 8 digit reference increases significantly to:</p><p>1,113,034,787,454,976 (1 quadrillion)</p><p>For perspective if a hacker were to try every second to get into your data it would take them 35,294,101 (35 million) years to go through each combination</p> |
|  BrandedHardCopyStylesheet\_v2           | <p>This is a setting that typically will need to be added by IEG4. Once added it enables you to have a custom CSS file linked to the format of your PDFs. This means you can customise the look and feel of your PDFs. </p><p>You simply type the Branding folder and the CSS file e.g. </p><p>IEG4/pdfcustombranding.css</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ContrastStylesheet1\_v2                  | <p>This allows you to use your own custom light high contrast stylesheet. Simply create a custom stylesheet and then place it in a branding folder. </p><p>You then simply type the Branding folder and the CSS file e.g. </p><p>IEG4/contrastlight.css</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ContrastStylesheet2\_v2                  | <p>This allows you to use your own custom dark high contrast stylesheet. Simply create a custom stylesheet and then place it in a branding folder. </p><p>You then simply type the Branding folder and the CSS file e.g. </p><p>IEG4/contrastdarkmode.css</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| EnableDeclarationCheckbox                | This will always be set to true and ensure your customers need to click a declaration check box to agree to the terms of your declaration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| EnablePrintConfirmation                  | This should always be false as it was superseded by the declaration check box option.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| EnablePrintableDeclaration               | This should always be false as it was superseded by the declaration check box option.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ShowPrintConfirmationInPerson            | This should always be false as it was superseded by the declaration check box option.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| AddressLookupAvailable                   | When true this means wherever an address is present it will use an address look up.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| AddressLookupType                        | This will be extract or API based. This will be superseded in 2020 when national address look ups are made open source                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ShowGenderQuestion                       | When set to true a customer will be asked for their gender on the Equalities page if this is present in forms.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ShowAgeQuestion                          | When set to true a customer will be asked for their age group on the Equalities page if this is present in forms                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ShowBeliefQuestion                       | When set to true a customer will be asked for their religion on the Equalities page if this is present in forms                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ShowSexualOrientationQuestion            | When set to true a customer will be asked for their sexual orientation on the Equalities page if this is present in forms                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ShowDisabilityQuestion                   | When set to true a customer will be asked for their disability status on the Equalities page if this is present in forms                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ShowPreferredMethodOfContact             | This controls whether the 'Select your preferred method of contact' is shown in forms on the 'Who Are You' page.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| UploadTotalQuota                         | This is the maximum limit of ALL files uploaded i.e. roughly 30MB is what it is set to now but can be changed by you.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| EnableAutoActionRetry                    | Sometimes the back office will be down and as a consequence we keep a copy of a file for it to be re-processed. We’ve recently added the ability for the system to automatically attempt to repost items where the back office is down. Thereby saving any manual intervention needed because of down time in the back office.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| WaitMinutesBeforeActionRetry             | This is the amount of time in minutes before the system will attempt a retry                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ActionRetryMaxDaysCutoff                 | This the maximum number of days the system will attempt to repost a file if it continues to fail                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ShowAssistedQuestions                    | When set to true an additional question will be asked at the bottom of the 'Who Are You Page' which is whether someone is assisting the person. If yes additional questions are asked.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| InProgressReminderEnabled                | This controls whether email reminders are sent to customers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| InProgressReminderFormAgeHours           | This is the period of time that should elapse from when the customer last accessed/save their form before a reminder is sent. Clearly they need to have provided an email address on the 'Who Are You' page for this to work.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| InProgressReminderSubjectTemplate        | This is the subject of the reminder email that will be sent.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| InProgressReminderBodyTemplate           | This is the body of the reminder email that will be sent to the customer.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| EmailIntegrationFailureEnabled           | Setting this to true means integration failures will be sent to the email recipient set in the next setting.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| EmailIntegrationFailureRecipient         | This indicates whom will be sent integration failures. I.e. you type an email address here.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| EmailIntegrationFailureTemplate          | This is the content of the email that will be sent. This tells the officer which form it was, which reference and which type of integration failure it was.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| MapsApiKey                               |  This holds the Bing Maps API Key for users with eDesigner that are adding map controls on to their form.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| TreatStartPageAsWhoAreYouPage            | This enables you to use the 'Start' page as the page which captures the email address that will be used for Save For Later and Submission email receipts. This setting is: **TreatStartPageAsWhoAreYouPage**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
