Components
Templates are managed using a single iCM Form App. Template data is saved to the iCM database in two encoded iCM Objects. A group of end points handles the creation, retrieval, import and export of template data. A single end point can be used to send all communications.
| Component Type | Name |
|---|---|
| Form | COMMSTEMPLATEMANAGER |
| End Point Group | goss.CommsTemplateManager |
| Configuration End Point | config.[env].CommsTemplatemanager.getConfig |
| Object Types | EMAILMANAGEMENT and EMAILTEMPLATES |
End Points
The CTM uses the standard GOSS end point configuration structure.
The configuration end point holds the following settings.
function(params, credentials) {
let config = {};
config.sendEmail = true;
config.sendSMS = false;
config.emailWorker = '';
config.smsWorker = '';
config.commsProviders = {
icm: {},
govNotify: {
emailTemplateId: "b9c6be73-xxxx-xxxx-xxxx-8bce922c18ec",
smsTemplateId: "e4d3358a-xxxx-xxxx-xxxx-b82b240ae0cd"
}
};
return config;
}
| Property | Type | Description |
|---|---|---|
| sendEmail | Boolean | true to enable emails |
| sendSMS | Boolean | true to enable SMS messages |
| emailWorker | String | The name of the email worker. An empty string will use the platform's "email" worker. The only options are icm or govNotify |
| smsWorker | String | The name of the SMS worker. An empty string will use the platform's "sms" worker (if enabled) |
| commsProviders | Object | Additional configuration for the email or SMS service, see below |
Enabling GOV.UK Notify
Notify is a premium service. You'll need to have a GOV.UK Notify account and the GOSS GovNotify Connector (worker) to use this feature.
Changing the worker configuration to use govNotify is a universal change that will be applied to all products/applications that send emails via the Comms Manager. If you have existing HTML templates this will need to be rewritten in Markdown.
The Notify integration has been written in a way that expects your full template to be written in the Comms Manager, and a single basic template, with just a ((body)) placeholder is created in Notify and used for all emails - see Markdown with GOV.UK Notify for a full description.
The ID of your template should be added here as the
Share this page
