diff --git a/app/models/bulk_upload.rb b/app/models/bulk_upload.rb index 9db828184..70b591b91 100644 --- a/app/models/bulk_upload.rb +++ b/app/models/bulk_upload.rb @@ -116,6 +116,14 @@ class BulkUpload < ApplicationRecord bulk_upload_errors.distinct.count("row") end + def remaining_logs_with_errors_count + logs.filter_by_status("in_progress").count + end + + def remaining_errors_count + logs.filter_by_status("in_progress").map(&:missing_answers_count).sum(0) + end + private def generate_identifier diff --git a/app/models/forms/bulk_upload_lettings/guidance.rb b/app/models/forms/bulk_upload_lettings/guidance.rb index 862a8af51..66683eb9b 100644 --- a/app/models/forms/bulk_upload_lettings/guidance.rb +++ b/app/models/forms/bulk_upload_lettings/guidance.rb @@ -15,17 +15,29 @@ module Forms bulk_upload_lettings_log_path(id: "prepare-your-file", form: { year: }) end - def legacy_template_path + def lettings_legacy_template_path Forms::BulkUploadLettings::PrepareYourFile.new.legacy_template_path end - def template_path + def lettings_template_path Forms::BulkUploadLettings::PrepareYourFile.new(year:).template_path end - def specification_path + def lettings_specification_path Forms::BulkUploadLettings::PrepareYourFile.new(year:).specification_path end + + def sales_legacy_template_path + Forms::BulkUploadSales::PrepareYourFile.new.legacy_template_path + end + + def sales_template_path + Forms::BulkUploadSales::PrepareYourFile.new(year:).template_path + end + + def sales_specification_path + Forms::BulkUploadSales::PrepareYourFile.new(year:).specification_path + end end end end diff --git a/app/models/forms/bulk_upload_sales/guidance.rb b/app/models/forms/bulk_upload_sales/guidance.rb index eb472ad3a..44987cd87 100644 --- a/app/models/forms/bulk_upload_sales/guidance.rb +++ b/app/models/forms/bulk_upload_sales/guidance.rb @@ -15,15 +15,27 @@ module Forms bulk_upload_sales_log_path(id: "prepare-your-file", form: { year: }) end - def legacy_template_path + def lettings_legacy_template_path + Forms::BulkUploadLettings::PrepareYourFile.new.legacy_template_path + end + + def lettings_template_path + Forms::BulkUploadLettings::PrepareYourFile.new(year:).template_path + end + + def lettings_specification_path + Forms::BulkUploadLettings::PrepareYourFile.new(year:).specification_path + end + + def sales_legacy_template_path Forms::BulkUploadSales::PrepareYourFile.new.legacy_template_path end - def template_path + def sales_template_path Forms::BulkUploadSales::PrepareYourFile.new(year:).template_path end - def specification_path + def sales_specification_path Forms::BulkUploadSales::PrepareYourFile.new(year:).specification_path end end diff --git a/app/models/log.rb b/app/models/log.rb index b588e1269..8814e771d 100644 --- a/app/models/log.rb +++ b/app/models/log.rb @@ -203,6 +203,12 @@ class Log < ApplicationRecord }.compact end + def missing_answers_count + form.questions.count do |question| + !optional_fields.include?(question.id) && question.displayed_to_user?(self) && question.unanswered?(self) && !question.is_derived_or_has_inferred_check_answers_value?(self) + end + end + private # Handle logs that are older than previous collection start date diff --git a/app/models/validations/sales/property_validations.rb b/app/models/validations/sales/property_validations.rb index b1bdb5b62..3a8f6a463 100644 --- a/app/models/validations/sales/property_validations.rb +++ b/app/models/validations/sales/property_validations.rb @@ -5,6 +5,8 @@ module Validations::Sales::PropertyValidations if record.discounted_ownership_sale? && record.ppostcode_full != record.postcode_full record.errors.add :postcode_full, I18n.t("validations.property.postcode.must_match_previous") record.errors.add :ppostcode_full, I18n.t("validations.property.postcode.must_match_previous") + record.errors.add :ownershipsch, I18n.t("validations.property.postcode.must_match_previous") + record.errors.add :uprn, I18n.t("validations.property.postcode.must_match_previous") end end diff --git a/app/services/bulk_upload/lettings/year2023/row_parser.rb b/app/services/bulk_upload/lettings/year2023/row_parser.rb index 3c5069063..094c63d45 100644 --- a/app/services/bulk_upload/lettings/year2023/row_parser.rb +++ b/app/services/bulk_upload/lettings/year2023/row_parser.rb @@ -415,7 +415,13 @@ class BulkUpload::Lettings::Year2023::RowParser fields = field_mapping_for_errors[error.attribute] || [] fields.each do |field| - unless errors.include?(field) + next if errors.include?(field) + + question = log.form.get_question(error.attribute, log) + + if question.present? && setup_question?(question) + errors.add(field, error.message, category: :setup) + else errors.add(field, error.message) end end diff --git a/app/services/bulk_upload/sales/year2023/row_parser.rb b/app/services/bulk_upload/sales/year2023/row_parser.rb index d5dca1c04..6ed79f3af 100644 --- a/app/services/bulk_upload/sales/year2023/row_parser.rb +++ b/app/services/bulk_upload/sales/year2023/row_parser.rb @@ -509,7 +509,13 @@ class BulkUpload::Sales::Year2023::RowParser fields = field_mapping_for_errors[error.attribute] || [] fields.each do |field| - unless errors.include?(field) + next if errors.include?(field) + + question = log.form.get_question(error.attribute, log) + + if question.present? && setup_question?(question) + errors.add(field, error.message, category: :setup) + else errors.add(field, error.message) end end diff --git a/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb b/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb index 0dbd25c46..41564c7b2 100644 --- a/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb +++ b/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb @@ -9,27 +9,30 @@
<%= govuk_link_to "Read the full guidance", bulk_upload_lettings_log_path(id: "guidance", form: { year: @form.year }) %> before you start if you have not used bulk upload before.
Use one of these templates to upload logs for 2023/24:
There are 7 or 8 rows of content in the templates. These rows are called the ‘headers’. They contain the CORE form questions and guidance about which questions are required and how to format your answers.
<%= govuk_link_to "Read the full guidance", bulk_upload_sales_log_path(id: "guidance", form: { year: @form.year }) %> before you start if you have not used bulk upload before.
Use one of these templates to upload logs for 2023/24:
There are 7 or 8 rows of content in the templates. These rows are called the ‘headers’. They contain the CORE form questions and guidance about which questions are required and how to format your answers.
You can upload one sales or lettings log at a time, or many at once (known as ‘bulk upload’) with a comma-separated values (CSV) spreadsheet file.
-Bulk upload may be easier if your organisation deals with many logs, or if you can export CSV data from your Housing Management System (HMS). If your organisation only deals with a small amount of logs, or you cannot export CSV data, it’s probably easier to enter logs individually.
- <%= govuk_warning_text text: "You cannot upload lettings and sales logs with the same template - you must export each data type separately, then upload them" %> -Bulk upload may be easier if your organisation deals with many logs, or if you can export CSV data from your Housing Management System (HMS).
-To bulk upload successfully, all spreadsheets must be in the correct CSV format.
-In most programs, you must resave files as CSV - it’s not usually the default setting. CSV files are also unformatted, so any formatting added before saving (for example colours) will automatically disappear.
- <%= govuk_details(summary_text: "More about CSV") do %> -A CSV file is a basic spreadsheet with data values in plain text, and columns separated by commas. Each data row is a new text line.
-CSV data is easier to process than more common advanced spreadsheet formats, for example Excel. It means CSV is well suited to upload large, or multiple data sets.
- <% end %> +If your organisation only deals with a small amount of logs, or you cannot export CSV data, it’s probably easier to create logs individually using the online form.
Export CSV data directly from your current systems, or export then adjust it to CSV.
-You can then upload it via a button at the top of the lettings and sales logs pages.
- - <%= govuk_details(summary_text: "My organisation has a HMS") do %> -Some HMS providers sell an add-on "eCORE" module, which exports CSV data for you.
-It can take HMS providers a while to update these per new collection year, so you may have to wait for updates to export, or adjust your data manually post-export.
+ <%= govuk_accordion do |accordion| %> + <%= accordion.with_section(heading_text: "Exporting your data", expanded: true) do %> +Export CSV data directly from your current systems.
+You should export lettings and sales data separately, and data from different collection years separately.
+The exported CSV file should have one row per log so that the data can fit into the bulk upload template.
+If your organisation has an HMS
+Some HMS providers sell an add-on "eCORE" module, which exports CSV data in the format we require.
+If your organisation does not have an HMS
+Your organisation’s IT team may be able to export CSV data for you, depending on how data is stored in your organisation.
+Review the bulk upload template and specification carefully to understand how we expect data to be mapped and formatted. The next 2 sections explain more about these documents.
<% end %> - <%= govuk_details(summary_text: "My organisation does not have a HMS") do %> -Your organisation’s IT team may be able to export CSV data for you - <%= govuk_link_to "find out more about data specification", @form.specification_path, target: "_blank" %>. This document outlines:
+ <%= accordion.with_section(heading_text: "Using the bulk upload template") do %> +For each collection year, we publish a bulk upload template and specification.
+The bulk upload templates contain 7 or 8 rows of ‘headers’ with information about how to fill in the template, including:
Fields must be in the same order as <%= govuk_link_to "the template", @form.template_path %>. Copy each column of your exported data one at a time and paste into the correct template column.
- <% else %> -Fields can appear in any order, as long as you include the <%= govuk_link_to "template document", @form.template_path %> headers, to easily identify what each column represents. You can rearrange data columns to match your system exports, copy-pasting multiple columns at once. For data stored in multiple systems, you can copy-paste all columns for one system next to each other, repeating this for subsequent system exports.
- <% end %> +You can paste your data below the headers or copy the headers and insert them above the data in your file. The bulk upload fields start at column B. Leave column A blank.
+Make sure that each column of data aligns with the corresponding question in the headers. We recommend ordering your data to match the headers, but you can also reorder the headers to match your data. When processing the file, we check what each column of data represents based on the headers above.
+For 2023/24 uploads, there are 2 templates to choose from, a new template and a legacy template. They outline suggested ways of ordering your data.
+You must include the headers in your file when you upload, unless your data matches the exact order of the legacy template. If you choose to remove the headers, you must also remove the blank column A.
+ +New template: In this template, the questions are in the same order as the 2023/24 paper form and web form. Use this template if your organisation is new to bulk upload or if your housing management system matches the new column ordering.
+<%= govuk_link_to "Download the lettings bulk upload template (2023 to 2024) – New question ordering", @form.lettings_template_path %>
+<%= govuk_link_to "Download the sales bulk upload template (2023 to 2024) – New question ordering", @form.sales_template_path %>
+ +Legacy template: In this template, the questions are in the same order as the 2022/23 template, with new questions added on to the end. Use this template if you have not updated your system to match the new template yet.
+<%= govuk_link_to "Download the lettings bulk upload template (2023 to 2024) - Legacy version", @form.lettings_legacy_template_path %>
+<%= govuk_link_to "Download the sales bulk upload template (2023 to 2024) – Legacy version", @form.sales_legacy_template_path %>
<% end %> -There is no step-by-step bulk upload guide like there is with single log upload. However, you can download <%= @form.year == 2022 ? govuk_link_to("our template", @form.template_path) : "one of our templates" %>, which you can copy-paste data into from your systems column-by-column. You can also view a post-upload report showing any data errors, and our <%= govuk_link_to "data specification", @form.specification_path, target: "_blank" %> can help fix these.
- <% if @form.year == 2023 %> - <%= govuk_details(summary_text: "How to choose the right template") do %> -Use one of these templates to upload logs for 2023/24:
-<%= govuk_link_to "New template", @form.template_path %>: In this template, the questions are in the same order as the 2023/24 paper form and web form. Use this template if your organisation is new to bulk upload or if your housing management system matches the new column ordering.
-<%= govuk_link_to "Legacy template", @form.legacy_template_path %>: In this template, the questions are in the same order as the 2022/23 template, with new questions added on to the end. Use this template if you have not updated your system to match the new template yet.
- <% end %> + <%= accordion.with_section(heading_text: "Using the bulk upload specification") do %> +The bulk upload specification contains the same information as the template headers, as well as more details about the accepted responses for each question. For multiple-choice questions, we use number or letter codes to represent each option, and the specification shows what answer each code represents.
+There is a separate specification for lettings and sales:
+<%= govuk_link_to "Download the lettings bulk upload specification (2023 to 2024)", @form.lettings_specification_path, target: "_blank" %>
+<%= govuk_link_to "Download the sales bulk upload specification (2023 to 2024)", @form.sales_specification_path, target: "_blank" %>
+If your upload fails because there are errors in the data, you can use the specification to help correct the errors. Having your file, the error report, and the specification open at the same time will make it easy to cross-reference field numbers and check accepted responses.
<% end %> -If you still need support mapping data in the way we need, DLUHC’s helpdesk can help. If your data is across multiple systems, or is hard to export as a single file in the correct format, you could try different exports, or copy-pasting data by hand.
-To bulk upload successfully, all spreadsheets must be in the correct CSV format.
+If you’ve pasted your data into the template, you will need to resave the file as a CSV.
+CSV files are unformatted, so any formatting added before saving (for example colours) will automatically disappear.
+What is a CSV?
+A CSV file is a basic spreadsheet with data values in plain text, and columns separated by commas. Each data row is a new text line.
+CSV data is easier to process than more common advanced spreadsheet formats, for example Excel. It means CSV is well suited to upload large data sets.
+ + <% end %> + + <%= accordion.with_section(heading_text: "Next steps") do %> +Once you've saved your CSV file, you can upload it via a button at the top of the lettings and sales logs pages.
+When your file is done processing, you will receive an email explaining your next steps. If all your data is valid, your logs will be created. If some data is invalid, you’ll receive an email with instructions about how to resolve the errors.
+If your file has errors on fields 1 through 17, you must fix these in the CSV. This is because we need to know these answers to validate the rest of the data. Any errors in these fields will be featured in the error report’s summary tab.
+If none of your errors are in fields 1 through 17, you can choose how to fix the errors. You can either fix them in the CSV and reupload, or create partially complete logs and answer the remaining questions on the CORE site. Any errors that affect a significant number of logs will be featured in the error report’s summary tab to help you decide.
+ + <% end %> + + <%= accordion.with_section(heading_text: "Getting help") do %> +The bulk upload template and specification should contain all the information you need to format your data correctly and fix any errors found during processing. If you still need support with your bulk upload, <%= govuk_link_to "contact the helpdesk", GlobalConstants::HELPDESK_URL %>.
+ <% end %> + <% end %> diff --git a/app/views/logs/index.html.erb b/app/views/logs/index.html.erb index 15b8f79d4..66f50c3d7 100644 --- a/app/views/logs/index.html.erb +++ b/app/views/logs/index.html.erb @@ -48,7 +48,7 @@- You have uploaded <%= pluralize(@bulk_upload.logs.count, "log") %>. There are errors in <%= pluralize(@bulk_upload.logs_with_errors_count, "log") %>, and <%= pluralize(@bulk_upload.bulk_upload_errors.count, "error") %> in total. Select the log to fix the errors. + You have uploaded <%= pluralize(@bulk_upload.logs.count, "log") %>. There are errors in <%= pluralize(@bulk_upload.remaining_logs_with_errors_count, "log") %>, and <%= pluralize(@bulk_upload.remaining_errors_count, "error") %> in total. Select the log to fix the errors.
diff --git a/spec/models/validations/sales/property_validations_spec.rb b/spec/models/validations/sales/property_validations_spec.rb index af65446fc..0152428d8 100644 --- a/spec/models/validations/sales/property_validations_spec.rb +++ b/spec/models/validations/sales/property_validations_spec.rb @@ -25,12 +25,16 @@ RSpec.describe Validations::Sales::PropertyValidations do record.postcode_full = "SW1A 1AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to be_empty + expect(record.errors["ppostcode_full"]).to be_empty + expect(record.errors["ownershipsch"]).to be_empty end it "when postcode_full is not present no error is added" do record.ppostcode_full = "SW1A 1AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to be_empty + expect(record.errors["ppostcode_full"]).to be_empty + expect(record.errors["ownershipsch"]).to be_empty end it "when postcodes match no error is added" do @@ -38,6 +42,8 @@ RSpec.describe Validations::Sales::PropertyValidations do record.ppostcode_full = "SW1A 1AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to be_empty + expect(record.errors["ppostcode_full"]).to be_empty + expect(record.errors["ownershipsch"]).to be_empty end it "when postcodes do not match an error is added" do @@ -45,6 +51,8 @@ RSpec.describe Validations::Sales::PropertyValidations do record.ppostcode_full = "SW1A 0AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to include(match I18n.t("validations.property.postcode.must_match_previous")) + expect(record.errors["ppostcode_full"]).to include(match I18n.t("validations.property.postcode.must_match_previous")) + expect(record.errors["ownershipsch"]).to include(match I18n.t("validations.property.postcode.must_match_previous")) end end end diff --git a/spec/requests/lettings_logs_controller_spec.rb b/spec/requests/lettings_logs_controller_spec.rb index d2ea715ff..6a33ee027 100644 --- a/spec/requests/lettings_logs_controller_spec.rb +++ b/spec/requests/lettings_logs_controller_spec.rb @@ -552,7 +552,7 @@ RSpec.describe LettingsLogsController, type: :request do let(:user) { create(:user, organisation:) } let(:bulk_upload) { create(:bulk_upload, :lettings, user:) } - let!(:included_log) { create(:lettings_log, :in_progress, bulk_upload:, owning_organisation: organisation) } + let!(:included_log) { create(:lettings_log, :completed, age1: nil, bulk_upload:, owning_organisation: organisation) } let!(:excluded_log) { create(:lettings_log, :in_progress, owning_organisation: organisation, tenancycode: "fake_code") } before do @@ -602,6 +602,12 @@ RSpec.describe LettingsLogsController, type: :request do expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 1 error in total. Select the log to fix the errors.") end + it "displays dynamic error number" do + included_log.update!(age2: nil) + get "/lettings-logs?bulk_upload_id[]=#{bulk_upload.id}" + expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 2 errors in total. Select the log to fix the errors.") + end + it "displays meta info about the bulk upload" do get "/lettings-logs?bulk_upload_id[]=#{bulk_upload.id}" expect(page).to have_content(bulk_upload.filename) diff --git a/spec/requests/sales_logs_controller_spec.rb b/spec/requests/sales_logs_controller_spec.rb index e837a21dc..a9bf07883 100644 --- a/spec/requests/sales_logs_controller_spec.rb +++ b/spec/requests/sales_logs_controller_spec.rb @@ -449,7 +449,7 @@ RSpec.describe SalesLogsController, type: :request do let(:user) { create(:user, organisation:) } let(:bulk_upload) { create(:bulk_upload, :sales, user:) } - let!(:included_log) { create(:sales_log, :in_progress, purchid: "included_id", bulk_upload:, owning_organisation: organisation) } + let!(:included_log) { create(:sales_log, :completed, age1: nil, purchid: "included_id", bulk_upload:, owning_organisation: organisation) } let!(:excluded_log) { create(:sales_log, :in_progress, purchid: "excluded_id", owning_organisation: organisation) } before do @@ -499,6 +499,12 @@ RSpec.describe SalesLogsController, type: :request do expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 1 error in total. Select the log to fix the errors.") end + it "displays dynamic error number" do + included_log.update!(age2: nil) + get "/lettings-logs?bulk_upload_id[]=#{bulk_upload.id}" + expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 2 errors in total. Select the log to fix the errors.") + end + it "displays meta info about the bulk upload" do get "/sales-logs?bulk_upload_id[]=#{bulk_upload.id}" expect(page).to have_content(bulk_upload.filename) diff --git a/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb b/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb index 8ced94e45..d172321df 100644 --- a/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb +++ b/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb @@ -1465,6 +1465,29 @@ RSpec.describe BulkUpload::Lettings::Year2023::RowParser do expect(parser.errors.where(:field_3)).not_to be_present end end + + context "when user's org has absorbed owning organisation before the startdate" do + let(:merged_org) { create(:organisation, :with_old_visible_id, holds_own_stock: true) } + + let(:attributes) { setup_section_params.merge({ field_1: merged_org.old_visible_id, field_2: merged_org.old_visible_id, field_3: user.email }) } + + before do + merged_org.update!(absorbing_organisation: user.organisation, merge_date: Time.zone.today - 5.years) + merged_org.reload + user.organisation.reload + end + + it "is not permitted" do + parser = described_class.new(attributes) + + parser.valid? + expect(parser.errors[:field_1]).to include(/The owning organisation must be active on the tenancy start date/) + expect(parser.errors[:field_2]).to include(/The managing organisation must be active on the tenancy start date/) + expect(parser.errors[:field_7]).to include(/Enter a date when the owning and managing organisation was active/) + expect(parser.errors[:field_8]).to include(/Enter a date when the owning and managing organisation was active/) + expect(parser.errors[:field_9]).to include(/Enter a date when the owning and managing organisation was active/) + end + end end describe "#field_2" do # managing org diff --git a/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb b/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb index 58a077a1b..6f617b584 100644 --- a/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb +++ b/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb @@ -420,6 +420,29 @@ RSpec.describe BulkUpload::Sales::Year2023::RowParser do expect(parser.errors.where(:field_2)).not_to be_present end end + + context "when user's org has absorbed owning organisation before the startdate" do + let(:merged_org) { create(:organisation, :with_old_visible_id, holds_own_stock: true) } + + let(:attributes) { setup_section_params.merge({ field_1: merged_org.old_visible_id, field_2: user.email }) } + + before do + merged_org.update!(absorbing_organisation: user.organisation, merge_date: Time.zone.today - 3.years) + merged_org.reload + user.organisation.reload + user.reload + end + + it "is not permitted" do + parser = described_class.new(attributes) + + parser.valid? + expect(parser.errors[:field_1]).to include(/The owning organisation must be active on the sale completion date/) + expect(parser.errors[:field_3]).to include(/Enter a date when the owning organisation was active/) + expect(parser.errors[:field_4]).to include(/Enter a date when the owning organisation was active/) + expect(parser.errors[:field_5]).to include(/Enter a date when the owning organisation was active/) + end + end end describe "#field_2" do # username for created_by