From 8917a1492ad79d11c543f266b7db5914f71dbe2d Mon Sep 17 00:00:00 2001 From: emmagifford <162720670+emmagifford@users.noreply.github.com> Date: Thu, 15 May 2025 10:44:16 +0000 Subject: [PATCH 1/2] Added inset text to clarify that personalisation fields must match the PDS fields exactly, including capitalisation. Changed all references to 'placeholders' to 'personalisation fields', as agreed with Sian and Alex. --- .../pages/using-nhs-notify/personalisation.md | 21 +++++++++++-------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/pages/using-nhs-notify/personalisation.md b/docs/pages/using-nhs-notify/personalisation.md index b73719b..c491339 100644 --- a/docs/pages/using-nhs-notify/personalisation.md +++ b/docs/pages/using-nhs-notify/personalisation.md @@ -12,7 +12,7 @@ section: Writing a message You can send personalised messages by adding personalisation fields to a single template. -Use double brackets to add a placeholder to your content. Do not include spaces in your placeholder text. For example: +Use double brackets to add a personalisation field to your content. Do not include spaces in your personalisation fields. For example: {% include components/inset-text.html text='Hello ((fullName)), your NHS Number is ((nhsNumber))' @@ -27,7 +27,7 @@ You can use: NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields for each recipient. This happens automatically when you [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) using recipients' NHS numbers. -You can use the following PDS personalisation fields in your templates: +To use PDS personalisation fields in your templates, choose from the following list: - fullName - firstName @@ -35,7 +35,10 @@ You can use the following PDS personalisation fields in your templates: - nhsNumber - date -Any placeholders in your content need to match the PDS personalisation fields. +{% include components/inset-text.html + text='Make sure your personalisation fields exactly match the PDS personalisation fields. This includes using the correct order of upper and lower case letters.' +%} + ## Custom personalisation fields @@ -57,7 +60,7 @@ Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs- Include the personalisation fields as columns in your CSV file. -The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template. +The column names should start with 'personalisation\_', followed by the same wording as the personalisation fields in your template. For example, if you wanted to include 'practice' as a personalisation field, the column name would be: @@ -73,7 +76,7 @@ You'll need to provide example data if you're using custom personalisation field Download and complete our [example personalisation data spreadsheet]({% link assets/personalisationexampledata/personalisation-example-data-nhs-notify.xlsx %}). -The placeholders in your content must match the fields in the 'personalisation field' column. +The personalisation fields in your content must match the fields in the 'personalisation field' column. You'll need to provide short, medium and long lengths of example data for each of your personalisation fields. @@ -95,7 +98,7 @@ Your example data does not need to be real data. ### Fields to avoid for custom personalisation -If you want to use custom personalisation, do not use the following placeholders: +If you want to use custom personalisation, do not use the following personalisation fields: - emailAddress - phoneNumber @@ -108,11 +111,11 @@ If you want to use custom personalisation, do not use the following placeholders - addressLine7 - [PDS personalisation fields](#personal-demographics-service-pds-personalisation-fields) -Custom personalisation will not work if you try to add it using these placeholders. This includes variations such as spaces and upper or lower cases. +Custom personalisation will not work if you try to add it using these personalisation fields. This includes variations such as spaces and upper or lower cases. -You can include extra words in your custom personalisation placeholders to make them different from the fields to avoid. +You can include extra words in your custom personalisation fields to make them different from the fields to avoid. -For example, if you wanted to include GP practice phone number as a custom personalisation field, your placeholder could be: +For example, if you wanted to include GP practice phone number as a custom personalisation field, your personalisation field could be: {% include components/inset-text.html text='((GP_phoneNumber))' From a8860c548323b5ffd1f80462842a2d3142fffed6 Mon Sep 17 00:00:00 2001 From: emmagifford <162720670+emmagifford@users.noreply.github.com> Date: Fri, 16 May 2025 10:24:53 +0000 Subject: [PATCH 2/2] Multiple consecutive blank lines fix and adding phoneNumber to list of accepted terms --- docs/pages/using-nhs-notify/personalisation.md | 1 - scripts/config/vale/styles/Vocab/words/accept.txt | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/using-nhs-notify/personalisation.md b/docs/pages/using-nhs-notify/personalisation.md index c491339..b00c882 100644 --- a/docs/pages/using-nhs-notify/personalisation.md +++ b/docs/pages/using-nhs-notify/personalisation.md @@ -39,7 +39,6 @@ To use PDS personalisation fields in your templates, choose from the following l text='Make sure your personalisation fields exactly match the PDS personalisation fields. This includes using the correct order of upper and lower case letters.' %} - ## Custom personalisation fields You can add custom personalisation fields that use your own personalisation data. diff --git a/scripts/config/vale/styles/Vocab/words/accept.txt b/scripts/config/vale/styles/Vocab/words/accept.txt index dd57c11..1a4865b 100644 --- a/scripts/config/vale/styles/Vocab/words/accept.txt +++ b/scripts/config/vale/styles/Vocab/words/accept.txt @@ -44,3 +44,4 @@ Marino Rica Futuna Tokelau +phoneNumber