To configure the CORE return data fields

Parent Previous Next

<This topic is in draft form only - it has been constructed solely from the corresponding requirements documentation and supporting use cases>


The procedure to configure the CORE return data fields is as follows:

  1. Navigate to Quick Menu > Allocations > Configuration >  Core Form. The Core Form window is displayed.
  2. Expand a data collection year and linked social housing regulator from the alphabetical list and select an associated CORE form, or type its name into the Search CORE Forms field. By default the list is filtered to show Current CORE forms. An alternative filter can be applied using the Select view drop-down field: Expired, Future or All 1.
  3. Using the Applicable Tenures drop-down field, multi-select all parameter values to which this CORE form applies e.g. Assured, Assured Starter, Secured, etc, or choose the All option, as required 1.
  4. Double-click on the first row in the Questions summary table. The CORE Question Setup window is displayed.
  5. Where the question response is defined by Mapped Data Labels, activate the tick box provided and click on Define Data Label Mapping. This procedural step i covered separately in the topic To define the CORE return data label map.
  6. For questions where the response is Mandatory, activate the tick box provided.
  7. Using the Cx Data Type drop-down field, select an appropriate parameter value for the response i.e. Decimal, Integer, Date Only, Date & Time, Time Only, Text, Lookup, True or False.
  8. Using the Cx Table drop-down field, select an appropriate parameter value reflecting the location of the response data field.
  9. Using the Cx Field drop-down field, select the desired response data field from the list, filtered by the choice of Cx Table.
  10. Where the desired question response is part of a system lookup set, use the Cx Lookup Id drop-down field to select the data value identifier.
  11. Where the desired question response is part of a lookup table, use the Cx Lookup Table drop-down field to select the data value identifier.
  12. Where a bespoke SQL stored procedure has been created to control the response rules, enter the procedure name into the SQL Function field provided.
  13. Where the question is a contact-specific response, activate the Relates to Contact tick box provided.
  14. Where an alternative response is permitted to the one derived, activate the Allow Response Override tick box provided.
  15. Use the Help Text field to add a tool tip that will aid the end user in completing the response.
  16. Repeat steps 4 through 15 to configure additional questions
  17. Click on Save.


Tip

1 Where only a small number of parameter values are not required, activate the All tick box first and then de-select individual items from the full list, as required; the All tick box will be automatically removed once an item is de-selected.

Note

1 The Search CORE Forms field will match against any element of the communication description.


See related topics...

Statutory returns management overview

To preview the CORE return prior to submission

To submit the CORE return