Skip to content

Commit 7f7aa86

Browse files
authored
Update /get-started content CCM-13340
1 parent 99fafa0 commit 7f7aa86

13 files changed

Lines changed: 473 additions & 24 deletions
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Check which features you need and register
7+
parent: Get started
8+
nav_order: 5
9+
permalink: /get-started/check-which-features-you-need-and-register
10+
---
11+
12+
Link to decision tree and register interest form.
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Check you're ready for integration
7+
parent: Get started
8+
nav_order: 4
9+
permalink: /get-started/check-you-are-ready-for-integration
10+
---
11+
12+
## 1. Prepare your integration
13+
14+
You must prepare your integration before you can get access to NHS Notify's integration environment.
15+
16+
You'll need technical or developer support to complete tasks in this step.
17+
18+
### If you're using NHS Notify API
19+
20+
You'll need to:
21+
22+
{% include components/details.html
23+
heading='Set up your APIM application ID'
24+
text="To set up an APIM application ID, you need to:
25+
26+
1. <a href='https://digital.nhs.uk/developer' target='_blank'>Sign in to your NHS Digital developer account (opens in a new tab)</a>.
27+
2. Create an APIM application.
28+
3. Select 'integration test' as the environment.
29+
4. Select 'Communications Manager (integration environment)' as the connected API.
30+
"
31+
%}
32+
33+
{% include components/details.html
34+
heading='Choose how you want to see your message performance'
35+
text="To see how your messages perform, you can <a href='https://digital.nhs.uk/developer/api-catalogue/nhs-notify#get-/v1/messages/-messageId-' target='_blank'>get the status of a message (opens in a new tab)</a> or choose to receive <a href='https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/%3Cclient-provided-message-status-URI%3E' target='_blank'>realtime message callbacks (opens in a new tab)</a>.
36+
37+
If you want to receive realtime message status callbacks, you'll need to:
38+
39+
- decide which [message, channel or supplier statuses](/using-nhs-notify/message-channel-supplier-status) you want to receive
40+
- prepare an endpoint URL for your integration
41+
"
42+
%}
43+
44+
### If you're using NHS Notify MESH
45+
46+
You'll need to:
47+
48+
1. <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh/set-up-nhs-notify-mesh#set-up-your-mesh-mailboxes" target="_blank">Set up your MESH mailboxes (opens in a new tab)</a> and make a note of their IDs.
49+
2. Decide which reports you want when you get reports on how your messages perform.
50+
51+
## 2. Confirm your setup to get access to our integration environment
52+
53+
You must confirm how you'll be set up with NHS Notify using our online form so we can prepare your integration environment to meet your needs.
54+
55+
{% include components/inset-text.html
56+
text='Only complete the online form and confirm your setup if you’ve been invited to onboard.'
57+
classes='nhsuk-u-margin-top-2'
58+
%}
59+
60+
{% include components/action-link.html
61+
url='https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNFRYSDFTOUs5TzZQUjlOVUlGWTQxQTlMQy4u'
62+
text='Confirm your setup with NHS Notify'
63+
%}
64+
65+
### Before you confirm your setup
66+
67+
In the form you'll be asked to:
68+
69+
{% include components/details.html
70+
heading='Confirm your use case'
71+
text='You can only use NHS Notify if your organisation or service sends messages that are:
72+
73+
- [part of a campaign](/using-nhs-notify/campaigns)
74+
- [triggered when something happens in your service](/using-nhs-notify/event-based-messaging)
75+
- [sent directly on a one-to-one basis](/using-nhs-notify/direct-messaging)
76+
'
77+
%}
78+
79+
{% include components/details.html
80+
heading='Provide your message sender names'
81+
text='When you send messages you’ll need to tell your recipients who your messages are from by creating message sender names.
82+
83+
Before you provide your message sender names, you should understand more about:
84+
85+
- [NHS App sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#nhs-app-sender-name)
86+
- [email sender names and from addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#email-sender-name-and-from-email-address)
87+
- [email reply-to email addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#reply-to-email-address)
88+
- [text message sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#text-message-sender-name)
89+
'
90+
%}
91+
92+
{% include components/details.html
93+
heading='Provide more detail about your messages and how they’ll be sent'
94+
text='You’ll be asked if your organisation or service will:
95+
96+
- have finished drafts of the messages you want to send
97+
- send NHS App messages and if so, which links and URLs you’ll include
98+
- send letters in other languages and if so, which languages
99+
- send letters in accessible formats and if so, which formats
100+
- use Personal Demographics Service (PDS) fields
101+
- have your PDS test data ready
102+
- use custom personalisation fields
103+
- have test data prepared for your custom personalisation fields
104+
105+
The form will also ask for the routing plans that you want to use for your messages.
106+
'
107+
%}
108+
109+
{% include components/details.html
110+
heading='Tell us who will create and submit templates'
111+
text='You do not need to do this if you send direct messages and use free-text inputs.
112+
113+
When you get access to NHS Notify’s integration environment, you’ll need to [create and submit your templates](/using-nhs-notify/create-and-submit-a-template). These templates will be used as the messages you send when you go live.
114+
115+
To access this feature, you must nominate someone in your organisation or service to sign in with NHS Notify. This is because creating and submitting templates is only available to one person in an organisation or service at this time.
116+
117+
To sign into NHS Notify you must have a Care Identity (CIS2 authentication). If you do not have a Care Identity, we can help you create one.
118+
'
119+
%}
120+
121+
{% include components/details.html
122+
heading='Give accurate estimates on your message volumes and frequency'
123+
text='We need to understand how many messages you need to send and how often to set up your integration environment.
124+
125+
You’ll need to provide:
126+
127+
- how many messages you want to send per day
128+
- the maximum amount of messages you might send per day
129+
'
130+
%}
131+
132+
After you submit the form, it will be reviewed by NHS Notify's onboarding team.
133+
134+
They'll contact you to either:
135+
136+
- ask you about some of the answers you provided
137+
- provide access to NHS Notify's integration environment
138+
139+
## 3. Build your integration
140+
141+
Once you get access to our integration environment, you can start building your integration with <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">NHS Notify API (opens in a new tab)</a> or <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh" target="_blank">NHS Notify MESH (opens in a new tab)</a>.
142+
143+
How you build your integration to meet your needs is your responsibility.
144+
145+
If you're sending campaign or event based messages, you need to create and submit your templates during this step. You will also need to [approve your messages before we send them]({% link pages/using-nhs-notify/approve-your-messages.md %}).
146+
147+
## 4. Complete integration testing
148+
149+
You'll need to [complete integration testing]({% link pages/using-nhs-notify/complete-your-testing.md %}) to make sure you're ready to start sending messages with NHS Notify.
150+
151+
If you're sending NHS App messages, you'll also need to [complete NHS App testing]({% link pages/using-nhs-notify/complete-your-testing.md %}).
152+
153+
### If you're using NHS Notify API
154+
155+
Your onboarding manager will ask for your:
156+
157+
- production (PROD) application name
158+
- PROD application ID
159+
- consumer organisation name
160+
- JWKS resource URL (if you’re self-hosting)
161+
- key ID for JWKS and public key (if NHS Notify is hosting your keys via APIM)
162+
163+
### If you’re using NHS Notify MESH
164+
165+
Your onboarding manager will ask for your PROD Mesh Mailbox ID.
166+
167+
## Next step
168+
169+
Once you've completed all these tasks, you can check which NHS Notify features you'll need and register your interest.
170+
171+
{% include components/action-link.html
172+
url='/get-started/read-and-understand-our-terms-of-service'
173+
text='Check which features you can use and register'
174+
%}
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Check you can use NHS Notify
7+
parent: Get started
8+
nav_order: 1
9+
permalink: /get-started/check-you-can-use-nhs-notify
10+
---
11+
12+
You can only use NHS Notify if your organisation or service sends:
13+
14+
- event-based messages
15+
- direct messages
16+
- messages that are part of a campaign
17+
18+
You must also:
19+
20+
- be funded, directly or indirectly, by the NHS or NHS England
21+
- have funding or a budget agreed for sending messages
22+
- intend to only send communications to patients or other members of the public – NHS Notify cannot be used to message NHS staff
23+
- not use NHS Notify to send marketing communications
24+
- check if other organisations or teams within NHS are already sending messages about the same subject matter
25+
- have a way to get the NHS numbers of your recipients
26+
- have technical or developer support to build your integration with NHS Notify
27+
28+
## Next step
29+
30+
If you meet all these criteria, you now need to make sure you’re ready commercially.
31+
32+
{% include components/action-link.html
33+
url='/get-started/read-and-understand-our-terms-of-service'
34+
text='Read and understand our terms of service'
35+
%}

docs/pages/get-started/get-started.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,10 @@ has_children: true
99
permalink: /get-started/
1010
---
1111

12-
## 1. Check if NHS Notify is right for you
12+
If we use the original side-nav layout, we need a parent page for the get started section.
1313

14-
You can only use NHS Notify if your organisation or service sends:
14+
Then the 5 stages would sit as child pages under the parent page.
1515

16-
- [event-based messages]({% link pages/about/event-based-messaging.md %})
17-
- [direct messages]({% link pages/about/direct-messaging.md %})
18-
- [messages that are part of a campaign]({% link pages/about/campaigns.md %})
16+
This parent page could contain a high-level overview of the get started section.
1917

20-
You also need to have:
21-
22-
- funding or a budget agreed for sending messages
23-
- a way to get the NHS numbers of your recipients
24-
- technical or developer support to build your integration with NHS Notify
25-
26-
You should also know [how to onboard with NHS Notify]({% link pages/get-started/onboard-with-notify.md %}).
27-
28-
## 2. Register your interest
29-
30-
Complete the following form to register your interest with NHS Notify. This will open in a new tab.
31-
32-
{% include components/button.html
33-
text="Register your interest"
34-
url="https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNUNJUkpPTjBXMjdZM0xZT0ZHRUxBNFVWMy4u"
35-
target="_blank"
36-
%}
18+
This content isn't really necessary, but a parent page is necessary for this particular structure.

docs/pages/get-started/onboard-with-notify.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
layout: page
66
title: Onboard with NHS Notify
77
parent: Get started
8-
nav_order: 2
8+
nav_order: 6
99
permalink: /get-started/onboard-with-nhs-notify
10+
published: false
1011
---
1112

1213
Use this page to find out what you need to do step by step to onboard with NHS Notify.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Read and understand our terms of service
7+
parent: Get started
8+
nav_order: 2
9+
permalink: /get-started/read-and-understand-our-terms-of-service
10+
---
11+
12+
You must read and understand all of our service terms and get a legal opinion before you continue.
13+
14+
## Online connection agreement
15+
16+
If you’re an NHS England organisation, you’ll need to sign our [online connection agreement (opens in a new tab)](https://digital.nhs.uk/developer/guides-and-documentation/online-connection-agreement){:target="\_blank"}.
17+
18+
## Payment terms
19+
20+
The payment terms document is a financial agreement that sets out our charges and rules.
21+
22+
It will forms part of your wider connection agreement with NHS England.
23+
24+
[Read and understand our payment terms(opens in a new tab)]({% link pages/pricing-and-commercial/how-to-pay.md %}){:target="\_blank"}
25+
26+
## Memorandum of understanding
27+
28+
To use NHS Notify, you must agree to the terms in this memorandum of understanding and the payment terms.
29+
30+
We’ll send you the memorandum of understanding to sign digitally during onboarding. You must sign this before you can go live with NHS Notify.
31+
32+
[Read and understand our memorandum of understanding(opens in a new tab)]({% link pages/pricing-and-commercial/memorandum-of-understanding.md %}){:target="\_blank"}
33+
34+
## General terms and conditions
35+
36+
The purpose of the NHS Notify service terms and conditions is to outline the criteria that:
37+
38+
- a Connecting Party must be compliant with
39+
- are mandatory to be able to use the NHS Notify service
40+
41+
[Read and understand our general terms and conditions (opens in a new tab)](https://digital.nhs.uk/services/nhs-notify/terms-and-conditions){:target="\_blank"}
42+
43+
## Security
44+
45+
NHS Notify is part of NHS England and is built for the security needs of its organisations and services.
46+
47+
[Read and understand our security features and policy (opens in a new tab)]({% link pages/footer/security.md %}){:target="\_blank"}
48+
49+
When you’ve read and understood these and received appropriate legal advice, you must now check you’re ready to integrate.
50+
51+
## Acceptable use policy
52+
53+
Needed at this stage?
54+
55+
## Privacy (transparency notice)
56+
57+
Needed at this stage?
58+
59+
## Next step
60+
61+
Once you've read and understood our service terms, make sure you understand our onboarding timescales.
62+
63+
{% include components/action-link.html
64+
url='/get-started/understand-onboarding-timescales'
65+
text='Understand our onboarding timescales'
66+
%}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# Feel free to add content and custom Front Matter to this file.
3+
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4+
5+
layout: page
6+
title: Understand our onboarding timescales
7+
parent: Get started
8+
nav_order: 3
9+
permalink: /get-started/understand-onboarding-timescales
10+
---
11+
12+
You must understand how long it might take to go live with NHS Notify so you can plan your integration.
13+
14+
CONTENT TBC
15+
16+
## Next step
17+
18+
You must check you're ready for integration before you can register for NHS Notify.
19+
20+
{% include components/inset-text.html
21+
text='You’ll need technical or developer support to complete tasks in this next step.'
22+
classes='nhsuk-u-margin-top-2'
23+
%}
24+
25+
{% include components/action-link.html
26+
url='/get-started/check-you-are-ready-for-integration'
27+
text='Check you’re ready for integration'
28+
%}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: mini-hub
3+
title: Page 1 title
4+
nav_order: 1
5+
permalink: /mini-hub-example/
6+
mini_hub_topic: Mini hub example
7+
mini_hub_pages:
8+
- title: Page 1 title
9+
url: /mini-hub-example/
10+
current: true
11+
- title: Page 2 title
12+
url: /mini-hub-example/page-2
13+
- title: Page 3 title
14+
url: /mini-hub-example/page-3
15+
- title: Page 4 title
16+
url: /mini-hub-example/page-4
17+
- title: Page 5 title
18+
url: /mini-hub-example/page-5
19+
previous_page:
20+
next_page:
21+
title: Page 2 title
22+
url: /mini-hub-example/page-2
23+
---
24+
25+
## Placeholder content
26+
27+
This is placeholder content for page 1. Replace this with your actual content.
28+
29+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

0 commit comments

Comments
 (0)