Skip to content

Commit 2eaab4c

Browse files
authored
CCM-10177 custom personalisation fields to avoid list update and minor general improvements
1 parent 461feb5 commit 2eaab4c

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

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

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,34 +71,39 @@ For example, if you wanted to include 'practice' as a personalisation field, the
7171

7272
The data used in your personalisation fields can affect the formatting and length of your messages. This could make some messages cost more than expected.
7373

74-
You'll need to provide example data if you're using custom personalisation fields. This is so that we can show you what your templates will look like with different lengths of data in your personalisation fields.
74+
You need to give us example data if you use custom personalisation. This helps us show you what your templates will look like with different lengths of data in your personalisation fields.
7575

76-
Download and complete our [example personalisation data spreadsheet]({% link assets/personalisationexampledata/personalisation-example-data-nhs-notify.xlsx %}).
76+
Download and fill in our [example personalisation data spreadsheet]({% link assets/personalisationexampledata/personalisation-example-data-nhs-notify.xlsx %}).
7777

78-
The personalisation fields in your content must match the fields in the 'personalisation field' column.
78+
The personalisation fields in your message content must match the fields in the 'personalisation field' column of your spreadsheet.
7979

80-
You'll need to provide short, medium and long lengths of example data for each of your personalisation fields.
80+
For each personalisation field, you need to provide examples that are:
81+
82+
- short
83+
- medium
84+
- long
8185

8286
For example, if you had ((hospital_address_line)) as a personalisation field, you might choose the following example data:
8387

8488
{% include components/inset-text.html
8589
text='
8690

87-
- Hospital A - short length
88-
- Hospital ABCDE - medium length
89-
- Hospital ABCDEFGHIJKLMN - long length'
91+
- Hospital A (short)
92+
- Hospital ABCDE (medium)
93+
- Hospital ABCDEFGHIJKLMN (long)'
9094
%}
9195

92-
It's up to you to decide how many characters to use for the different lengths.
96+
You can decide how many characters to use for each length.
9397

94-
If your data will be a fixed length for a particular personalisation field, use 3 different examples of the same length.
98+
If the information for a field will always be the same length, give us 3 different examples that are all that same length.
9599

96100
Your example data does not need to be real data.
97101

98102
### Fields to avoid for custom personalisation
99103

100104
If you want to use custom personalisation, do not use the following personalisation fields:
101105

106+
- [PDS personalisation fields](#personal-demographics-service-pds-personalisation-fields)
102107
- emailAddress
103108
- phoneNumber
104109
- addressLine1
@@ -108,13 +113,21 @@ If you want to use custom personalisation, do not use the following personalisat
108113
- addressLine5
109114
- addressLine6
110115
- addressLine7
111-
- [PDS personalisation fields](#personal-demographics-service-pds-personalisation-fields)
116+
- middleNames
117+
- namePrefix
118+
- nameSuffix
119+
- date
120+
- clientRef
121+
- recipientContactValue
122+
- template
112123

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.
124+
{% include components/inset-text.html
125+
text='Custom personalisation will not work if you use these fields. This includes any variations, for example, if you add spaces, punctuation, and upper or lower case letters.'
126+
%}
114127

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

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

119132
{% include components/inset-text.html
120133
text='((GP_phoneNumber))'

0 commit comments

Comments
 (0)