H-CLIC Management

Created by Jake Baker, Modified on Mon, 12 Feb 2024 at 01:00 PM by Ashleigh Whitworth

This article will explain the functionality within HPA2 available to assist with managing your H-CLIC returns. This functionality assists you to keep your data clear of errors whilst saving you time, enabling on-time submissions of quality standards. 


Note: A topic of this article is bulk validation of up to 50 cases via the H-CLIC API. Single Case Validations are also possible, and encouraged, as part of the case workflow. They are explained within this alternative article. All users can run single case validations. 

Permissions & Access

In order to manage H-CLIC within HPA2, you'll need the relevant permissions. A user with the appropriate permissions can grant you these following the below steps:

  1. Click Settings
  2. Click Users
  3. Edit the user requiring the permission
  4. Grant the "Manage H-CLIC" permission within the HPA section
  5. Save changes


With the above steps completed, that user will now be able to manage H-CLIC information within HPA2.

Connecting to DELTA from HPA2 (Via the H-CLIC API)

HPA2 is integrated with DELTA to allow for the direct validation of cases to check for errors, as well as to allow for direct submission to DELTA without requiring you to leave HPA2 or download any files to upload to DELTA. In order to benefit from this integration, you are required to setup a DELTA login within HPA2, to do this follow these steps:

  1. Click Settings
  2. Click Partners
  3. Click Edit against the relevant partner (there will likely be only one partner displayed)
  4. Add the relevant H-CLIC login information against the four H-CLIC fields displayed
    1. H-CLIC API organisation-id
    2. H-CLIC API organisation-name
    3. H-CLIC API Username
    4. H-CLIC API Password
  5. Then click Save

Once the above steps are completed, you will be able to validate cases directly with DELTA, using the most up to date specification held within that system. You will also be able to submit your completed reports to DELTA, without being required to download any files and upload them manually. 

Running H-CLIC Reports

Once we have integrated with the DELTA H-CLIC API, we can utilise the validation tools within HPA2 to validate cases in bulk. This functionality allows you to efficiently and methodically process any outstanding backlog of cases to ensure they are compliant. 

In order to validate cases in bulk, we must first run a H-CLIC Report. To do this, follow the below steps:

  1. Click Reports
  2. Click H-CLIC
  3. Change the report Start and End Date fields to the relevant dates (this should align with quarters generally)
  4. Click Request Report

Did you know: The H-CLIC report might take a couple of minutes to finalise for viewing. The system is checking each case included within the return for their validation status.

Once the report is ready, you can begin validating the cases within - head to the next section of this article.

Bulk Validations

Did you know: To run Bulk Validations you'll need to have followed the steps in the previous section of this article, Running H-CLIC Reports. Up to 50 cases can be validated at a time using the Bulk Validation tool. This is a limit of the API to ensure good performance. However, this limit should not be a significant concern as best practice is to have officers validate and error-check cases as they go through the relevant triggers - not to validate all cases in bulk at the end of the quarter. 

From the H-CLIC Reports screen, follow the below steps to run Bulk Validations:

  1. Click "View" against the relevant report to open the list of cases included within the report.
  2. Use the checkbox to select which cases to validate 
  3. Click Validate

Did you know: Clicking the checkbox within the column header will select the first 50 cases which have not been validated or have errors. (See below image)

After you have run the validation tool, a screen similar to the below will open with the cases you validated alongside any errors found.

When you click a case, it will open it in a new tab. The H-CLIC report will appear on the right hand side of the screen, displaying any errors. For information on how to correct errors against individual cases, see this article.

When you return to your H-CLIC report, the cases you validated previously will have updates against the relevant columns - see below:

Note: Below is an explanation of what each of the validation outcomes mean:

OK     - No errors, no further action.
ERROR  - The tool detected errors and these will need fixing.
Blank  - This case requires validation. 

Note that if an officer changes H-CLIC information on a case, this case will require re-validation and so upon re-running your report you might find a case that was previously "OK" now has a blank Validation Outcome.

Submission to DELTA 

Once you have completed all the necessary error-checking within a H-CLIC report, it is ready for submission to DELTA. 

Note: We would recommend that you ensure your H-CLIC report is free of errors before submitting to DELTA.

Submitting the report to DELTA is very easy - in the below image we have highlighted the "Submit" button. When you're ready, click this button and the return will be sent. An automated email will be sent to you from DELTA inviting you to view the return's statistics. 

Note: Once you have submitted your H-CLIC report to DELTA, any changes made to cases within that report will not be reflected in DELTA. To update your return to DELTA, run another H-CLIC report for the relevant quarter, then submit again.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article