Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/_includes/breadcrumb.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@
</li>
{% endif %}

{% if page.parent == "Pagination example" %}
<li class="nhsuk-breadcrumb__list-item">
<a class="nhsuk-breadcrumb__link" href="{{site.baseurl}}/pagination-example">Pagination example</a>
</li>
{% endif %}

</ol>

<!-- Mobile breadcrumb back -->
Expand Down
25 changes: 25 additions & 0 deletions docs/_includes/components/contents-list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{%- comment -%}
NHS Contents List Component
Used for mini-hub navigation

Parameters:
- items: array of objects with 'title', 'url', and optional 'current' (boolean)

Example usage:
{% include components/contents-list.html items=page.mini_hub_pages %}
{%- endcomment -%}

<nav class="nhsuk-contents-list" role="navigation" aria-label="Pages in this guide">
<h2 class="nhsuk-u-visually-hidden">Contents</h2>
<ol class="nhsuk-contents-list__list">
{% for item in include.items %}
<li class="nhsuk-contents-list__item{% if item.current %} nhsuk-contents-list__item--current{% endif %}">
{% if item.current %}
<span class="nhsuk-contents-list__current" aria-current="page">{{ item.title }}</span>
{% else %}
<a class="nhsuk-contents-list__link" href="{{ item.url | prepend: site.baseurl }}">{{ item.title }}</a>
{% endif %}
</li>
{% endfor %}
</ol>
</nav>
48 changes: 48 additions & 0 deletions docs/_includes/components/pagination.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{%- comment -%}
NHS Pagination Component
Used for mini-hub page navigation

Parameters:
- previous: object with 'title' and 'url' (optional)
- next: object with 'title' and 'url' (optional)

Example usage:
{% include components/pagination.html previous=page.previous_page next=page.next_page %}
{%- endcomment -%}

<nav class="nhsuk-pagination" role="navigation" aria-label="Pagination">
<ul class="nhsuk-list nhsuk-pagination__list">
{% if include.previous %}
<li class="nhsuk-pagination-item--previous">
<a class="nhsuk-pagination__link nhsuk-pagination__link--prev"
href="{{ include.previous.url | prepend: site.baseurl }}">
<span class="nhsuk-pagination__title">Previous</span>
<span class="nhsuk-u-visually-hidden">:</span>
<span class="nhsuk-pagination__page">{{ include.previous.title }}</span>
<svg class="nhsuk-icon nhsuk-icon__arrow-left" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
aria-hidden="true" width="34" height="34">
<path
d="M4.1 12.3l2.7 3c.2.2.5.2.7 0 .1-.1.1-.4.1-.5v-2h11c.6 0 1-.4 1-1s-.4-1-1-1h-11V9c0-.2 0-.4-.1-.5-.2-.2-.5-.2-.7 0l-2.7 3c0 .2 0 .4.1.5h-.1z">
</path>
</svg>
</a>
</li>
{% endif %}
{% if include.next %}
<li class="nhsuk-pagination-item--next">
<a class="nhsuk-pagination__link nhsuk-pagination__link--next"
href="{{ include.next.url | prepend: site.baseurl }}">
<span class="nhsuk-pagination__title">Next</span>
<span class="nhsuk-u-visually-hidden">:</span>
<span class="nhsuk-pagination__page">{{ include.next.title }}</span>
<svg class="nhsuk-icon nhsuk-icon__arrow-right" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"
aria-hidden="true" width="34" height="34">
<path
d="M19.6 11.66l-2.73-3A.51.51 0 0 0 16 9v2H5a1 1 0 0 0 0 2h11v2a.5.5 0 0 0 .32.46.39.39 0 0 0 .18 0 .52.52 0 0 0 .37-.16l2.73-3a.5.5 0 0 0 0-.64z">
</path>
</svg>
</a>
</li>
{% endif %}
</ul>
</nav>
52 changes: 52 additions & 0 deletions docs/_layouts/mini-hub.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: default
---

<div class="nhsuk-width-container nhsnotify-mini-hub">
<main class="nhsuk-main-wrapper" id="maincontent" role="main">
<div class="nhsuk-grid-row">
<div class="nhsuk-grid-column-two-thirds">

{%- comment -%}
Mini-hub heading with topic subtitle
{%- endcomment -%}



<h1>
<span role="text">
{{ page.title }}
{% if page.mini_hub_topic %}
<span class="nhsuk-caption-xl nhsuk-caption--bottom">
<span class="nhsuk-u-visually-hidden">
-
</span>
{{ page.mini_hub_topic }}
</span>
{% endif %}
</span>
</h1>

{%- comment -%}
Contents list navigation
{%- endcomment -%}
{% if page.mini_hub_pages %}
{% include components/contents-list.html items=page.mini_hub_pages %}
{% endif %}

{%- comment -%}
Page content
{%- endcomment -%}
{{ content }}

{%- comment -%}
Pagination navigation
{%- endcomment -%}
{% if page.previous_page or page.next_page %}
{% include components/pagination.html previous=page.previous_page next=page.next_page %}
{% endif %}

</div>
</div>
</main>
</div>
2 changes: 2 additions & 0 deletions docs/assets/css/_nhsnotify.scss
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,8 @@
}
*/

/* Mini-hub breadcrumb styles removed */

// Home page button margin override
.nhsnotify-home-page .nhsuk-button {
margin-bottom: 0;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
layout: mini-hub
title: Check which features you need and register
nav_order: 5
permalink: /get-started-2/check-which-features-you-need-and-register
mini_hub_topic: Answer a few questions to see which features you need before you register
mini_hub_pages:
- title: Check you can use NHS Notify
url: /get-started-2/check-you-can-use-nhs-notify
- title: Read and understand our terms of service
url: /get-started-2/read-and-understand-our-terms-of-service
- title: Understand our onboarding timescales
url: /get-started-2/understand-onboarding-timescales
- title: Check you are ready for integration
url: /get-started-2/check-you-are-ready-for-integration
- title: Check which features you need and register
url:
current: true
previous_page:
title: Check you are ready for integration
url: /get-started-2/check-you-are-ready-for-integration
next_page:
---

Link to decision tree and register interest form.
184 changes: 184 additions & 0 deletions docs/pages/get-started-2/check-you-are-ready-for-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
---
layout: mini-hub
title: Check you are ready for integration
nav_order: 4
permalink: /get-started-2/check-you-are-ready-for-integration
mini_hub_topic: You must follow the steps to prepare for integration
mini_hub_pages:
- title: Check you can use NHS Notify
url: /get-started-2/check-you-can-use-nhs-notify
- title: Read and understand our terms of service
url: /get-started-2/read-and-understand-our-terms-of-service
- title: Understand our onboarding timescales
url: /get-started-2/understand-onboarding-timescales
- title: Check you are ready for integration
url:
current: true
- title: Check which features you need and register
url: /get-started-2/check-which-features-you-need-and-register
previous_page:
title: Understand our onboarding timescales
url: /get-started-2/understand-onboarding-timescales
next_page:
title: Check which features you need and register
url: /get-started-2/check-which-features-you-need-and-register
---

## 1. Prepare your integration

You must prepare your integration before you can get access to NHS Notify's integration environment.

You'll need technical or developer support to complete tasks in this step.

### If you're using NHS Notify API

You'll need to:

{% include components/details.html
heading='Set up your APIM application ID'
text="To set up an APIM application ID, you need to:

1. <a href='https://digital.nhs.uk/developer' target='_blank'>Sign in to your NHS Digital developer account (opens in a new tab)</a>.
2. Create an APIM application.
3. Select 'integration test' as the environment.
4. Select 'Communications Manager (integration environment)' as the connected API.
"
%}

{% include components/details.html
heading='Choose how you want to see your message performance'
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>.

If you want to receive realtime message status callbacks, you'll need to:

- decide which [message, channel or supplier statuses](/using-nhs-notify/message-channel-supplier-status) you want to receive
- prepare an endpoint URL for your integration
"
%}

### If you're using NHS Notify MESH

You'll need to:

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.
2. Decide which reports you want when you get reports on how your messages perform.

## 2. Confirm your setup to get access to our integration environment

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.

{% include components/inset-text.html
text='Only complete the online form and confirm your setup if you’ve been invited to onboard.'
classes='nhsuk-u-margin-top-2'
%}

{% include components/action-link.html
url='https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNFRYSDFTOUs5TzZQUjlOVUlGWTQxQTlMQy4u'
text='Confirm your setup with NHS Notify'
%}

### Before you confirm your setup

In the form you'll be asked to:

{% include components/details.html
heading='Confirm your use case'
text='You can only use NHS Notify if your organisation or service sends messages that are:

- [part of a campaign](/using-nhs-notify/campaigns)
- [triggered when something happens in your service](/using-nhs-notify/event-based-messaging)
- [sent directly on a one-to-one basis](/using-nhs-notify/direct-messaging)
'
%}

{% include components/details.html
heading='Provide your message sender names'
text='When you send messages you’ll need to tell your recipients who your messages are from by creating message sender names.

Before you provide your message sender names, you should understand more about:

- [NHS App sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#nhs-app-sender-name)
- [email sender names and from addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#email-sender-name-and-from-email-address)
- [email reply-to email addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#reply-to-email-address)
- [text message sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#text-message-sender-name)
'
%}

{% include components/details.html
heading='Provide more detail about your messages and how they’ll be sent'
text='You’ll be asked if your organisation or service will:

- have finished drafts of the messages you want to send
- send NHS App messages and if so, which links and URLs you’ll include
- send letters in other languages and if so, which languages
- send letters in accessible formats and if so, which formats
- use Personal Demographics Service (PDS) fields
- have your PDS test data ready
- use custom personalisation fields
- have test data prepared for your custom personalisation fields

The form will also ask for the routing plans that you want to use for your messages.
'
%}

{% include components/details.html
heading='Tell us who will create and submit templates'
text='You do not need to do this if you send direct messages and use free-text inputs.

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.

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.

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.
'
%}

{% include components/details.html
heading='Give accurate estimates on your message volumes and frequency'
text='We need to understand how many messages you need to send and how often to set up your integration environment.

You’ll need to provide:

- how many messages you want to send per day
- the maximum amount of messages you might send per day
'
%}

After you submit the form, it will be reviewed by NHS Notify's onboarding team.

They'll contact you to either:

- ask you about some of the answers you provided
- provide access to NHS Notify's integration environment

## 3. Build your integration

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

How you build your integration to meet your needs is your responsibility.

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 %}).

## 4. Complete integration testing

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.

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 %}).

### If you're using NHS Notify API

Your onboarding manager will ask for your:

- production (PROD) application name
- PROD application ID
- consumer organisation name
- JWKS resource URL (if you’re self-hosting)
- key ID for JWKS and public key (if NHS Notify is hosting your keys via APIM)

### If you’re using NHS Notify MESH

Your onboarding manager will ask for your PROD Mesh Mailbox ID.

## Next step

Once you've completed all these tasks, you can check which NHS Notify features you'll need and register your interest.
Loading
Loading