From a0f7a1d3e61a3217a775c95fdbdf4fb0e99a6b44 Mon Sep 17 00:00:00 2001
From: Lori Bailey <44073106+elceebee@users.noreply.github.com>
Date: Mon, 17 Jun 2024 17:06:40 +0100
Subject: [PATCH] Playbook update for adding ENIC references to qualifications

---
 docs/support_playbook.md | 67 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 64 insertions(+), 3 deletions(-)

diff --git a/docs/support_playbook.md b/docs/support_playbook.md
index 0fa8677bb92..08e52e7fbab 100644
--- a/docs/support_playbook.md
+++ b/docs/support_playbook.md
@@ -123,13 +123,74 @@ ApplicationForm.find(APPLICATION_FORM_ID)
 
 We've seen this happen due to a `nil` value for `predicted_grade`. To fix this update `predicted_grade` to false.
 
+### Creating a qualification
+(section reviewed 17 June 2024)
+
+Create the same qualification locally, turn the relevant fields into JSON, paste that into the prod shell, parse it and assigned attrs 😥 `qualification.as_json(only: [fields]).to_json`
+
 ### Update qualifications
+(section reviewed 17 June 2024)
 
 **Adding equivalency**
 
-TODO: rewrite this section
+If you are asked to add an ENIC number to a qualification, you should first make sure that what you are being asked to do is reflected on the ENIC statement. If you are in doubt refer it back to support or to policy.
 
-Create the same qualification locally, turn the relevant fields into JSON, paste that into the prod shell, parse it and assigned attrs 😥 `qualification.as_json(only: [fields]).to_json`
+`equivalency_details` is a field on the `ApplicationQualification` model, but it is not used. Do not add any data to this field. There is a card on trello to remove it from the database.
+For all international qualifications, you'll have to include an `institution_country`: https://github.com/DFE-Digital/apply-for-teacher-training/blob/78c9421d8582f63cfdec564b5c0677bfd787552c/config/initializers/countries_and_territories.rb
+
+***Degrees***
+
+It is most likely that you will only need to update the `enic_reference` and `comparable_uk_degree`, but you should look at the other relevant fields to make sure they also make sense
+
+Some notes about the required fields:
+
+- `enic_number` This is a 10 digit number on the ENIC statement of comparability. It's call 'UK ENIC reference' on the statement.
+- `comparable_uk_degree` This is an enum, use one of these valid options https://github.com/DFE-Digital/apply-for-teacher-training/blob/7d61f9887494aae093ced34f587d5870528ba786/app/models/application_qualification.rb`
+
+```ruby
+ApplicationQualification.find(QUALIFICATION_ID).update!(
+  enic_number:,
+  comparable_uk_degree:,
+  audit_comment: ZENDESK_URL,
+
+  # Other things to check against the ENIC certificate
+  level: 'degree',
+  institution_name:,
+  institution_country:,
+  qualification_type: 'non_uk',
+  non_uk_qualification_type: nil, # not to be confused with the comparable_uk_degree. This can should be blank for degrees
+  award_year: AWARD_YEAR,
+  equivalency_details: nil,
+  )
+````
+
+You may also be asked to remove ENIC / comparable_uk_degree information if the candidate has entered something like, 'awaiting response'. Just set the `enic_reference` and `comparable_uk_degree` to nil.
+
+***GCSEs***
+
+Some notes about the required fields:
+- `enic_number` This is a 10 digit number on the ENIC statement of comparability. It's call 'UK ENIC reference' on the statement.
+- `subject` usually one of the required GCSE subjects https://github.com/DFE-Digital/apply-for-teacher-training/blob/7d61f9887494aae093ced34f587d5870528ba786/app/models/application_qualification.rb#L41
+- `non_uk_qualification_type` Free text. Usually something like 'High School diploma', it should match what is on the ENIC certificate
+- `comparable_uk_qualification`. This is a string, not an enum. The possible text values are here: https://github.com/DFE-Digital/apply-for-teacher-training/blob/d95efba0a432715760e1686880e83e9bdbf8821e/config/locales/candidate_interface/gcse.yml#L42.
+For example, use 'GCSE (grades A*-C / 9-4)' NOT 'gcse'.
+
+```ruby
+ApplicationQualification.find(QUALIFICATION_ID).update!(
+  level: 'gcse',
+  enic_number:,
+  subject:,
+  non_uk_qualification_type:,
+  comparable_uk_qualification:,
+  audit_comment: ZENDESK_URL,
+
+  # Other things to check against the ENIC certificate
+  comparable_uk_degree: nil,
+  qualification_type: 'non_uk',
+  award_year:,
+  institution_country:,
+  )
+````
 
 **Change grade**
 
@@ -140,7 +201,7 @@ ApplicationQualification.find(ID).update!(grade: 'D', audit_comment: 'Updating g
 **Change start and graduation date**
 
 ```ruby
-ApplicationQualification.find(ID).update!(start_year: '2011', award_year: '2014', audit_comment: 'Updating an application after a user requested a change, ticket ZENDESK_URL'
+ApplicationQualification.find(ID).update!(start_year: '2011', award_year: '2014', audit_comment: 'Updating an application after a user requested a change, ticket ZENDESK_URL')
 ```
 
 **Delete a Qualification**