Configure default settings for Licence worksheets

A system administrator can configure settings that apply to all Licence applications.

  1. On the System Administration screen, under Public Protection, click Configure Licences.

    The List of Licences Setup screen appears.

  2. Click Defaults.

    The Licences Defaults Setup screen appears.

  3. On the General tab, specify the following:

    Field

    Description

    Time Taken Mandatory on Actions

    Whether all completed actions on the Actions tab of the application must have a Time Taken value (apart from the Procedure Started action).

    Check O/S Actions on Completion

    How you want ASSURE to respond to an attempt to complete the application while there are still outstanding actions:

    • Error

      An error message is displayed, and the user is not allowed to complete the application until all outstanding actions are either completed or deleted.

    • Warning

      A warning message is displayed, but the user is allowed to complete the application with some outstanding actions remaining.

    • Allow deletion of actions

      A confirmation message is displayed. The user is allowed to complete the application and can choose whether or not to delete all outstanding actions (if they have the ACTN-DELETE key in their security profile).

    Add Comment on Change of Officer

    Whether an action with a specific comment should be recorded on the Actions tab of the application whenever the Officer field on the Progress tab is changed.

    Change of Officer Action*

    The action to be recorded on the Actions tab of the application whenever the Officer field is changed.

    The Comments field of the action will be Passed from officer: Name1 to officer: Name2, followed by a specific comment if required.

    Email Officer on Allocation

    Whether a pre-defined notification email should be sent to the allocated officer whenever the Officer field is set or changed.

    Display Alert

    Whether the Alert Messages dialog opens automatically:

    • Insert

      Whenever an alerted address, person or vehicle is added to the application.

    • Edit

      Whenever the application is opened.

    Default Outcomes

    The default Completion Outcome to be recorded on the Progress tab of the application when issuing a licence for a New Application Transaction (that is, the first issue) and any Post-issue Transaction (such as a Renewal, Transfer or Variation).

    Mandatory Fields

    Whether the Officer and Area fields on the Progress tab are mandatory:

    • Always

      Validated every time the application is saved.

    • Completion

      Validated only when the application is completed.

    Alternative References

    The names (labels) of up to six Alternative Reference fields to appear on the Progress tab.

    * Mandatory if Add Comment on Change of Officer is ticked.

  4. Optionally, on the Validations tab, specify one or more validation rules.

    1. Click Add more to add a validation rule, or Edit to change an existing rule.

      A Validation Details dialog opens.

    2. Define the rule.

      Parameters of a validation rule

      Field

      Description

      Field Name*

      The field to which validation is applied.

      • Title

      • Date of Birth

      • Age (calculated from the date of birth)

      • Preferred Method of Written Contact (PMoWC)

      • National Insurance Number (NINO)

      • Preferred Telephone Number

      • Alternative Telephone Number

      • Email Address

      Note: Some of these fields may not be present for this application. Rules based on absent fields will be ignored.

      Visible

      Whether the field is visible:

      • Yes

      • No

      • Not Applicable (to this rule)

      Do not use Not Applicable unless the field's visibility is determined by an earlier rule.

      Mandatory

      Whether the field is mandatory, and in what circumstances.

      • Always (mandatory on saving)

      • Submission (mandatory on submission, for a public-facing application)

      • Issue (mandatory on issue or grant of the licence)

      • Completion (mandatory on completion of the application)

      • No (not mandatory)

      Comparator and Value

      A condition that the field must satisfy to be considered valid.

      The Comparator can be any of:

      • Equal to

      • Not Equal to

      • Less than

      • Less than or Equal to

      • Greater than

      • Greater than or Equal to

      The Value to which the field is compared can be up to 20 characters.

      Prevent Submission

      Whether a missing or invalid field prevents submission of a public-facing application.

      • Yes

      • No

      • Not Applicable (to this rule)

      Prevent Issue

      Whether a missing or invalid field prevents the licence being issued.

      • Yes

      • No

      • Not Applicable (to this rule)

      * Mandatory fields.

    3. Click OK.

    Repeat as required. Click red cross icon and confirm to remove an unwanted rule.

    Tip

    If the result of these rules is not what you expect, check to ensure that the rules are not contradictory.

  5. On the Licence Register tab:

    • Under Default Response Codes, select the Licence Representation Response codes that correspond to the Objection, No Objection and Supported responses to Licence applications that are open for representations, by either a statutory consultee via their My Consultations screen, or a public user via the Licence Register.

    • Under Default Representation Types, select the Licence Representation Type codes that correspond to how a public user can identify themself when making representations via the Licence Register; that is, as a Neighbour, Neighbouring Business or Other.

    These settings are required only if your authority has licensed the optional Statutory Consultations or Licence Register feature.

  6. Optionally, on the Online Payments tab, override the editable Online Payments settings for this application by ticking the adjacent Set Here checkbox and specifying a local value.

    • Adelante payment systemClosed

      Details for the Adelante payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      ADELANTE

      Channel

      Your authority's Adelante channel code.

      Fund Code

      The fund to which payments are allocated.

      Caller ID

      An authority-specific reference identifier.

      Payment Provider URL

      The Adelante payment system URL.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Uneditable fields.

    • Barclaycard™ payment systemClosed

      Details for the Barclaycard™ payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      BARCLAYCARD

      Affiliation Name

      Your authority's Barclaycard payment service provider ID (PSPID).

      SHA-IN Passphrase

      Your authority's Secure Hash Algorithm pass phrase. Barclaycard impose restrictions on the composition of the pass phrase and the minimum number of characters.

      Payment Provider URL

      The Barclaycard payment system URL.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Application ID

      An optional application identifier.

      Uneditable fields.

    • Capita SCP payment systemClosed

      Details for the Capita SCP payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      CAPITA SCP

      Fund Code

      Customer-specific fund code.

      Income Code

      Customer-specific income code.

      XML Field

      The element of the Capita XML schema to which the income code (if specified) is mapped.

      Payment Provider URL

      The Capita Secure Card Portal (SCP) payment system URL.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Payment Back URL

      The URL to return to if the user clicks Back on the Capita SCP Payment screen.

      Site ID

      Your authority's site ID assigned by Capita.

      SCP ID

      One of the Secure Card Portal instances assigned to your authority by Capita.

      HMAC Key ID

      The keyed-hash message authentication code (HMAC) for this SCP instance, assigned by Capita.

      HMAC Key

      The HMAC secret key for this SCP instance, assigned by Capita.

      Uneditable fields.

    • Civica payment systemClosed

      Details for the Civica payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      CIVICA

      Payment Provider URL

      The Civica payment system URL.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Calling Application ID

      Which application is using the payment system.

      Fund Code

      An account type for the specified calling application that is used to identify the system to which the transaction should be exported and whether the general ledger should be updated with this payment.

      GL Code

      A general ledger code of the form NNNN/AANN.

      Uneditable fields.

    • GOV.UK Pay payment systemClosed

      Details for the Worldpay payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      GOVUKPAY

      API Key

      The live API key for the ASSURE system or a module.

      Payment Provider URL

      The GOV.UK Pay payment system URL.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Uneditable fields.

    • PARIS payment systemClosed

      Details for the PARIS payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      PARIS

      Customer Reference / Invoice Number

      An optional value that is used only when testing online payments.

      Description of Payment

      Description to be sent with the payment to PARIS, for example Application Fee.

      Fund Code

      The payment fund code.

      Payment Provider URL

      The PARIS payment system URL.

      Payment Return Text

      Text returned after a successful payment, for example Fee Accepted.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Uneditable fields.

    • Worldpay payment systemClosed

      Details for the Worldpay payment system

      Field

      Description

      Authority

      Please Select denotes the default or only configuration; otherwise, the authority to which this configuration applies.

      Payment Provider

      WORLDPAY

      Installation ID

      Your authority's Worldpay payment service provider ID.

      Payment Provider URL

      The Worldpay payment system URL.

      Payment Return URL

      This should be the external URL for the ReceivePaymentTransaction page.

      Mode

      Whether the Payment Provider URL is for a Live (0) or Test (100) account.

      Merchant ID

      An optional application identifier.

      Uneditable fields.

    Any configuration, including the default, can be removed by clicking red cross icon.

  7. Optionally, on the SMS Configuration tab, override the ASSURE-wide SMS settings by ticking the adjacent Set Here checkboxes and specifying local values.

  8. Optionally, on the Appointments Configuration tab, override the ASSURE-wide appointment booking service (ABS) settings by ticking the adjacent Set Here checkboxes and specifying local values.

    Appointments Configuration settings

    Field

    Description

    Appointments Provider

    The ABS provider.

    Note: Only Microsoft Bookings is currently supported.

    Client ID

    Your authority's client ID.

    Azure Application ID

    Azure's registered application ID.

    Client Secret

    Your authority’s client secret.

    Business ID

    A specific department or directorate within your authority for which appointments may be booked. Each business can offer multiple booking services.

    Uneditable fields.

    Click Test Connection to ensure that the settings work as expected.

    Important

    If MS Bookings' Refresh Token has expired, or is due to expire in the next 10 days, on clicking Test Connection ASSURE takes you to the Appointments Configuration screen from where the tokens can be renewed. Between 30 and 10 days before expiry, ASSURE gives you the option of renewing the tokens, but you can choose not to.

    Tell me more

  9. On the Automated Actions tab, specify what automated events and actions are associated with this application.

    Automated actions are caused by automated events, subject to certain conditions that you can define. You can choose which actions are caused by which events, but the types of actions and their parameters are predefined.

    • To add a new event, click Add more and select it from the Automated Event list.

    • For an existing event, click Add more to specify a new action in the Action dialog:

      Field

      Description

      Action Type*

      The type of action; for example: Create Letter or Create Worksheet (if available).

      Action Name*

      The name of the action within this event.

      Parameters*

      If required, one or more parameters. Click Add more to add additional parameters.

      The parameters depend on the type of action:

      • For a Create Letter action the parameters are one or more document templates from the relevant document group.

      • For a Create Worksheet action the parameters are the task type of an Inspection worksheet and the responsible officer.

      * Mandatory fields.

    • Click Edit to edit or red cross icon to delete an existing action.

  10. Click Save and Exit to return to the System Administration screen.