Notify ServiceAdmin User Guide
Purpose
The purpose of this document is to outline the ServiceAdmin user functionality of a Notify Service.
Pre-requisites
- The client will need to have been set up and agreed to the T and C's for the Notify portal.
- The Notify Service has been set up on DTT by NotifyAdmin
Platform URLs
The table below provides the details of the URLs for the Digital Transactional Toolkit (DTT)
| Platform | URL |
|---|---|
| Digital Transactional Toolkit | https://dttadmin.public.nics.gov.uk/DSSNotify/notify |
DTT Notify Setup
The following sections describe the steps required to administer a Notify service on the DTT platform.
Log into the DTT Platform
To access DTT notify, navigate to https://dttadmin.public.nics.gov.uk where your Tenant dashboard will be displayed, showing any tenants you may be associated with. On the screen below there is only one tenant (DSSNotify) but you may have others.
!
Select DSS Notify and the GOV Notify service(s) will display as shown (below)
The GOV Notify service, is the parent tenant, where Admin can set up and administer all Notify services.
Create a new Notify Service
On entering the GOV Notify Service, there will be a menu on the left-hand side, detailing the actions that are available to you as a User. Not all Users will have the same items, based on their role in the service.
The create notify service screen, has four mandatory fields to be completed before the service can be set up:
- Service Name – this is the name of the new service. The name should be entered without any spaces
- Service Display Name – this is the name that will be displayed to Users
- Notify API Key – this is the API key that was copied from GOV UK Notify Portal
- Notify Template ID - this is the template key that was copied from GOV UK Notify Portal
Once the fields are completed, select the Create Notify Service Button and the service will be created – example below.
The new service will be visible in the Notify Service tab
And as a new child service on the Service Dashboard.
Additional Notify Services can be created from either the left-hand menu or from the Create Notify button on the Notify Services screen.
Editing a Notify Service
If a user needs to edit the details of a service, they should select the edit button displayed against the service to be edited on the list of services
Selecting the Edit button, will display the Service fields, and once edited the changes are saved by selecting the Update Notify Service button. *Service Name cannot be edited.
Create A Campaign
In order to Create a new campaign, the user should select the Create Campaign item from the left-hand menu. The Create campaign screen will display:
The dropdown will give you a list of campaign types that can created.
There are 3 types of campaign that can be created:
- Campaign - where Contacts will be permanently stored (users opt in or out)
The create campaign screen, has five mandatory fields to be completed before the service can be set up :
- Campaign Name – this is the Display name of the campaign
- Description – a brief description of the purpose of the campaign
- Campaign Mobile Number – mobile number for specific campaign
- Opt in Keyword Phrase – phrase by which user can opt into the campaign and start receiving messages.
- Opt Out Keyword Phrase – phrase by which user can opt out of the campaign and stop receiving messages.
Note
When a user opts in or out of a campaign, they will receive an automated confirmation message Thank you - You have successfully registered for {campaign} notifications or Thank you - You have successfully unregistered for {campaign} notifications
Once the fields are completed, select Create Campaign and a new campaign will display on the Campaign list screen.
- Campaign - where contacts will be used once
- Campaign - Appointment - where contacts will be deleted once message sent.
For all Campaign types, the Campaign List screen shows the actions available to a user on the right-hand side of the Campaign row in the list. The four actions that are available are :
- Send a Message
- Edit Campaign
- Upload users
Further Campaigns can be set up from either the Left-hand menu or the Add Campaign button on the Campaign List screen
Edit a campaign
If a user wants to edit the details of a campaign, they should select the Edit icon from the right-hand side of the row on the Campaign list.
Selecting the Edit button, will display the Campaign fields, and once edited the changes are saved by selecting the Update Notify Service button.
Upload Permanent Contacts
When setting up a campaign, the user can upload a list of subscribers to the campaign (permanent contacts). It will be these users (and any who opt in manually) that will receive sent SMS'.
Once selected, the Upload screen will display. The user should select to 'Choose file' and locate and upload the contact list. Once selected, the user should Map Records to commit the list to the campaign details.
Send a Message
If a user wants to send a message on a campaign, they should select the Send Message button on the required campaign. The type of campaign selected will determine the next screens displayed.
Once selected the Send message screen will display.
- For the Campaign that reuses contacts and users opt in and out of the service, the following screen displays.
The user should enter the text of the message they wish to send. (There will be a message character count on screen and an informational message regarding the size/costing of the message for example, 1 SMS or 2SMS etc)
Selecting the Send Message button will then distribute a text to all recipients who have opted into receiving texts for the campaign selected.
The user will receive a successful confirmation message
- For the Campaign where contacts are used only once or for the 'Appointment' type campaign, the sender must upload the contact and appointment details first.
Once an Appointment Campaign has been created, the user must first upload a list of contacts and/or appointment details before the message can be sent.(If there is no contacts uploaded, the Send message button will not appear). This must be in the form of a .csv file and contain all the required fields for the message. There are up to 4 fields permitted to be uploaded :
mobile number: the number to which the message will be sent (this is only field for 'once' type campaigns.)
appointment location : the place the appointment will take place
appointment date : the date of the appointment
appointment time : the time for the given appointment.
These fields must be mapped to the csv ensure use correct use in the message.
Once the contact details have been uploaded, the Send message button will appear on against the campaign
When the send message button is selected , the message text screen will appear.
The fields uploaded in the csv file and mapped to the campaign, should be entered in { } in the text of the message - as per the example .
Create a Message Template
In addition to the Send message functionality, a User can set up message templates for their campaign using the template functionality.
There can be multiple (or no) templates for each campaign. This means they can template a message for re-use, rather than having to enter the same text each time.
To do this, the user should select the Message List menu item from the left-hand menu. Once selected the Create template screen will display.
The create Template screen, has two mandatory fields to be completed before the template can be set up (templates are usually set up by the ServiceAdmin of the Notify service):
- Template Name – this is the name of the Template.
- Please enter the template text message – this is the message text that will be delivered to subscribers
Selecting Create Template will confirm the details and display the new template on the Template List.
Once at least one template has been created for a Campaign, the Send message screen will appear differently to that described in 3.4.1
Once Send message is selected, the Send message screen will now contain a Dropdown list, displaying all templates that exist for that campaign. The user will be able to either select a template or enter new text in the text box.
Appointment Campaign Templates
Appointment Campaigns are those that allow a user to send appointment details via sms. The message will contain the date, time and location of the appointment. Therefore when a template is set up for one of these campaign types, it should include the required bookmark fields
Then when the user selects to send a message, the template will be available for selection. The bookmarked fields will be automatically populated with the data from the .csv and the message sent to multiple users.
A new contact list should be uploaded for each new group message.
Notify Reports
If a User has the ReportUser role. there will be a left hand menu item : Report list
When selected this component permits the user to select any available reports.
Once the report has been selected, the user can select a Start Date and End date for the report data , and select to view the report.
Once generated, the report will display on screen. The results can be filtered and sorted using the filter section within the data grid and sorted by using the arrows.
The data can also be exported to csv using the create spreadsheet button.
