Skip to content

Commit 4288394

Browse files
authored
Merge branch 'main' of https://github.com/NHSDigital/nhs-notify-web-cms into out-of-box-v1
2 parents f2b317e + f29be76 commit 4288394

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

docs/pages/using-nhs-notify/personalisation.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ section: Writing a message
1212

1313
You can send personalised messages by adding personalisation fields to a single template.
1414

15-
Use double brackets to add a placeholder to your content. Do not include spaces in your placeholder text. For example:
15+
Use double brackets to add a personalisation field to your content. Do not include spaces in your personalisation fields. For example:
1616

1717
{% include components/inset-text.html
1818
text='Hello ((fullName)), your NHS Number is ((nhsNumber))'
@@ -27,15 +27,17 @@ You can use:
2727

2828
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.
2929

30-
You can use the following PDS personalisation fields in your templates:
30+
To use PDS personalisation fields in your templates, choose from the following list:
3131

3232
- fullName
3333
- firstName
3434
- lastName
3535
- nhsNumber
3636
- date
3737

38-
Any placeholders in your content need to match the PDS personalisation fields.
38+
{% include components/inset-text.html
39+
text='Make sure your personalisation fields exactly match the PDS personalisation fields. This includes using the correct order of upper and lower case letters.'
40+
%}
3941

4042
## Custom personalisation fields
4143

@@ -57,7 +59,7 @@ Read the [API documentation](https://digital.nhs.uk/developer/api-catalogue/nhs-
5759

5860
Include the personalisation fields as columns in your CSV file.
5961

60-
The column names should start with 'personalisation\_', followed by the same wording as the placeholders in your template.
62+
The column names should start with 'personalisation\_', followed by the same wording as the personalisation fields in your template.
6163

6264
For example, if you wanted to include 'practice' as a personalisation field, the column name would be:
6365

@@ -73,7 +75,7 @@ You'll need to provide example data if you're using custom personalisation field
7375

7476
Download and complete our [example personalisation data spreadsheet]({% link assets/personalisationexampledata/personalisation-example-data-nhs-notify.xlsx %}).
7577

76-
The placeholders in your content must match the fields in the 'personalisation field' column.
78+
The personalisation fields in your content must match the fields in the 'personalisation field' column.
7779

7880
You'll need to provide short, medium and long lengths of example data for each of your personalisation fields.
7981

@@ -95,7 +97,7 @@ Your example data does not need to be real data.
9597

9698
### Fields to avoid for custom personalisation
9799

98-
If you want to use custom personalisation, do not use the following placeholders:
100+
If you want to use custom personalisation, do not use the following personalisation fields:
99101

100102
- emailAddress
101103
- phoneNumber
@@ -108,11 +110,11 @@ If you want to use custom personalisation, do not use the following placeholders
108110
- addressLine7
109111
- [PDS personalisation fields](#personal-demographics-service-pds-personalisation-fields)
110112

111-
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.
113+
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.
112114

113-
You can include extra words in your custom personalisation placeholders to make them different from the fields to avoid.
115+
You can include extra words in your custom personalisation fields to make them different from the fields to avoid.
114116

115-
For example, if you wanted to include GP practice phone number as a custom personalisation field, your placeholder could be:
117+
For example, if you wanted to include GP practice phone number as a custom personalisation field, your personalisation field could be:
116118

117119
{% include components/inset-text.html
118120
text='((GP_phoneNumber))'

scripts/config/vale/styles/Vocab/words/accept.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,5 @@ Marino
4444
Rica
4545
Futuna
4646
Tokelau
47-
Wayfinder
4847
phoneNumber
48+
Wayfinder

0 commit comments

Comments
 (0)